Represents a Source Group Builder. More...

Inheritance diagram for SourceGroupBuilder:

Public Member Functions
'None'	AddSources (self, vSources)
	Adds sources into the simulation.

'None'	RemoveSources (self, vSources)
	Deletes sources from the simulation.

Public Member Functions inherited from FeatureBuilder
'None'	ShowResult (self)
	Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.

Public Member Functions inherited from Builder
'None'	Commit (self)
	Commits any edits that have been applied to the builder.

Static Public Attributes
str	Sources = property(fget=__GetSources)
	Gets source features.

Static Public Attributes inherited from FeatureBuilder
str	Feature = property(fget=__GetFeature)
	Returns the feature being edited, or the created feature if the builder is being used in creation mode.

str	FullName = property(fget=__GetFullName)
	Gets the full name of the feature being edited.

str	Name = property(fget=__GetName, fset=__SetName)
	Gets or sets the name of the feature being edited.

str	NameWithContext = property(fget=__GetNameWithContext)
	Gets the name with context of the feature being edited.

str	Status = property(fget=__GetStatus)
	Returns the status of the feature being edited.

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Properties inherited from FeatureBuilder
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Properties inherited from Builder
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Detailed Description

Represents a Source Group Builder.

The Source Group Builder is used to group several sources in the same group.

To create a new instance of this class, use FeatureCollection::CreateSourceGroupBuilder

Member Function Documentation

'None' AddSources	(		self,
			vSources )

Adds sources into the simulation.

Parameters

[in] sources : List of Feature object

'None' RemoveSources	(		self,
			vSources )

Deletes sources from the simulation.

Parameters

[in] sources : List of Feature object

str Sources = property(fget=__GetSources)

static

Gets source features.

Gets the current source features that are in the simulation.

Value type: List of Feature object.

The documentation for this class was generated from the following file: