ObjectCoverageFigureOfMerit#

class ansys.stk.core.stkobjects.ObjectCoverageFigureOfMerit#

Class defining the fom on the coverage object tool.

Overview#

set_definition_type

Set the definition type.

is_definition_type_supported

Get a value indicating whether the specified type can be used.

set_access_constraint_definition

Set the access constraint definition.

set_access_constraint_definition_name

Set the access constraint definition by name.

definition_type

Definition type for the FOM.

definition_supported_types

Return an array of valid choices.

definition

Definition properties of the FOM.

graphics

2D graphics properties of the FOM.

Import detail#

from ansys.stk.core.stkobjects import ObjectCoverageFigureOfMerit

Property detail#

property ObjectCoverageFigureOfMerit.definition_type: FigureOfMeritDefinitionType#

Definition type for the FOM.

property ObjectCoverageFigureOfMerit.definition_supported_types: list#

Return an array of valid choices.

property ObjectCoverageFigureOfMerit.definition: IFigureOfMeritDefinition#

Definition properties of the FOM.

property ObjectCoverageFigureOfMerit.graphics: FigureOfMeritGraphics#

2D graphics properties of the FOM.

Method detail#

ObjectCoverageFigureOfMerit.set_definition_type(self, defn: FigureOfMeritDefinitionType) None#

Set the definition type.

Parameters:

defn : FigureOfMeritDefinitionType

Returns:

None

ObjectCoverageFigureOfMerit.is_definition_type_supported(self, defn: FigureOfMeritDefinitionType) bool#

Get a value indicating whether the specified type can be used.

Parameters:

defn : FigureOfMeritDefinitionType

Returns:

bool

ObjectCoverageFigureOfMerit.set_access_constraint_definition(self, constraint_name: FigureOfMeritConstraintName) FigureOfMeritDefinitionAccessConstraint#

Set the access constraint definition.

Parameters:

constraint_name : FigureOfMeritConstraintName

Returns:

FigureOfMeritDefinitionAccessConstraint

ObjectCoverageFigureOfMerit.set_access_constraint_definition_name(self, constraint_name: str) FigureOfMeritDefinitionAccessConstraint#

Set the access constraint definition by name.

Parameters:

constraint_name : str

Returns:

FigureOfMeritDefinitionAccessConstraint