Ctrl+K

altdss.DSSObj

altdss.DSSObj#

Module Contents#

Classes#

DSSObj

IDSSObj

API#

class altdss.DSSObj.DSSObj(api_util, ptr)#

Bases: altdss.common.Base

FullName() → str#
property Name: str#
__hash__()#

Return hash(self).

__init__(api_util, ptr)#
__ne__(other)#

Return self!=value.

__repr__()#

Return repr(self).

begin_edit() → None#

Marks a DSS object for editing

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

end_edit(num_changes: int = 1) → None#

Leaves the editing state of a DSS object

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)#

Returns an element’s data as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features.

By default (options = 0), only the properties explicitly set. The properties are returned in the order they are set in the input. As a reminder, OpenDSS is sensitive to the order of the properties.

The options bit-flags are available in the DSSJSONFlags enum. Values used by this function are:

  • Full: if set, all properties are returned, ordered by property index instead.

  • SkipRedundant: if used with Full, all properties except redundant and unused ones are returned.

  • EnumAsInt: enumerated properties are returned as integer values instead of strings.

  • FullNames: any element reference will use the full name ({class name}.{element name}) even if not required.

  • Pretty: more whitespace is used in the output for a “prettier” format.

  • SkipDSSClass: do not add the “DSSClass” property to the JSON objects.

NOT IMPLEMENTED YET:

  • State: include run-time state information

  • Debug: include debug information

Other bit-flags are reserved for future uses. Please use DSSJSONFlags enum to avoid potential conflicts.

(API Extension)

class altdss.DSSObj.IDSSObj(iobj, obj_cls, batch_cls)#

Bases: altdss.common.Base

__contains__(name: str) → bool#
__getitem__(name_or_idx)#
__init__(iobj, obj_cls, batch_cls)#
__iter__()#
__len__() → int#
batch(**kwargs)#

Creates a new batch handler of (existing) objects

batch_new(names: Optional[List[AnyStr]] = None, count: Optional[int] = None, begin_edit=None)#

Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.

find(name_or_idx: Union[AnyStr, int]) → altdss.DSSObj.DSSObj#

Returns an object from the collection by name or index; the index must be zero-based.

new(name: str, begin_edit=True, activate=False)#
Contents