KeywordOptions

class KeywordOptions

Options for keyword formatting

Members defined in KeywordOptions (40 members)

	action	RW	When action keyword is printed:
	allocation	RW	When allocation keyword is printed in allocation usages:
	assert_	RW	When assert keyword is printed in satisfy requirement usages:
	binding	RW	When binding keyword is printed in binding connectors as usages:
	comment	RW	When comment keyword is printed:
	concern	RW	When concern keyword is printed in framed concern usages:
	conjugates	RW	Choose between conjugates and ~ when formatting conjugations (KerML):
	conjugation	RW	When conjugation keyword is printed in conjugation members (KerML):
	connect	RW	When connect keyword is printed in interface usages:
	connection	RW	When connection keyword is printed in connection usages:
	constraint	RW	When constraint keyword is printed in assert constraint usages:
	crosses	RW	Choose between crosses and => when formatting cross subsettings:
	defined_by	RW	Choose between defined by and : when formatting feature typings (SysML, use typed-by for KerML):
	disjoining	RW	When disjoining keyword is printed in disjoining members (KerML):
	enum	RW	When enum keyword is printed inside enum definitions:
	equals	RW	When to print = in feature values:
	feature	RW	Options for feature keyword formatting (KerML).
	first	RW	When first keyword is printed:
	from_	RW	When from keyword is printed:
	inverting	RW	When inverting keyword is printed in inverting members (KerML):
	metadata	RW	Choose between metadata and @ tokens for metadata features and usages:
	null	RW	Option for NullExpression formatting:
	occurrence	RW	When occurrence keyword is printed:
	of	RW	When of keyword is printed:
	port	RW	When port keyword is printed of default interface ends:
	public	RW	When public keyword is printed:
	redefines	RW	Options for redefines keyword formatting.
	ref	RW	When ref keyword is printed
	references	RW	Choose between references and ::> when formatting reference subsettings:
	requirement	RW	When requirement keyword is printed in satisfy requirement usages:
	specialization	RW	Options for specialization keyword formatting member relationships (KerML).
	specializes	RW	Choose between specializes and :> when formatting specializations and subclassifications:
	state	RW	When state keyword is printed in exhibit state usages:
	subsets	RW	Choose between subsets and :> when formatting subsettings:
	succession	RW	When succession keyword formatting in successions as usages:
	transition	RW	When transition keyword is printed in transition usages:
	true	RW	When true keyword is printed in invariants:
	typed_by	RW	Choose between typed by and : when formatting feature typings (KerML):
	use_case	RW	When use case keyword is printed in include use case usages:
	__init__

 Attributes

property action: syside.conf.ActionKeyword

When action keyword is printed:

• always: action is always printed

• as-needed: action is only printed when required by the grammar

property allocation: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When allocation keyword is printed in allocation usages:

• always: allocation is always printed

• as-needed: allocation is only printed when required by the grammar

property assert_: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

When assert keyword is printed in satisfy requirement usages:

• always: assert is always printed

• never: assert is never printed

property binding: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When binding keyword is printed in binding connectors as usages:

• always: binding is always printed

• as-needed: binding is only printed when required by the grammar

property comment: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When comment keyword is printed:

• always: comment will always be printed

• as-needed: comment will only be printed as needed

property concern: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When concern keyword is printed in framed concern usages:

• always: concern is always printed

• as-needed: concern is only printed if required by the grammar

property conjugates: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between conjugates and ~ when formatting conjugations (KerML):

• keyword: conjugates is printed

• token: ~ is printed

property conjugation: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When conjugation keyword is printed in conjugation members (KerML):

• always: conjugation will always be printed.

• as-needed: conjugation will be printed only if required by the grammar

property connect: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When connect keyword is printed in interface usages:

• always: connect is always printed

• as-needed: connect is only printed when required by the grammar

property connection: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When connection keyword is printed in connection usages:

• always: connection is always printed

• as-needed: connection is only printed when required by the grammar

property constraint: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When constraint keyword is printed in assert constraint usages:

• always: constraint is always printed

• as-needed: constraint is only printed when required by the grammar

property crosses: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between crosses and => when formatting cross subsettings:

• keyword: crosses is printed

• token: => is printed

property defined_by: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between defined by and : when formatting feature typings (SysML, use typed-by for KerML):

• keyword: defined by is printed

• token: : is printed

property disjoining: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When disjoining keyword is printed in disjoining members (KerML):

• always: disjoining will always be printed.

• as-needed: disjoining will be printed only if required by the grammar

property enum: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

When enum keyword is printed inside enum definitions:

• always: enum is always printed

• never: enum is never printed

property equals: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When to print = in feature values:

• as-needed: = will only be printed if it is required by the grammar

• always: = will be always printed when it is acceptable by the grammar

property feature: syside.conf.FeatureKeyword

Options for feature keyword formatting (KerML).

property first: syside.conf.FirstKeyword

When first keyword is printed:

• always: first is always printed if permitted by the grammar

• as-needed: first is only printed if required by the grammar

property from_: syside.conf.FromKeyword

When from keyword is printed:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property inverting: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When inverting keyword is printed in inverting members (KerML):

• always: inverting will always be printed.

• as-needed: inverting will be printed only if required by the grammar

property metadata: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between metadata and @ tokens for metadata features and usages:

• keyword: metadata is printed

• token: @ is printed

property null: syside.conf.FormatPreserved[syside.conf.NullFormat]

Option for NullExpression formatting:

• null: always formatted as null

• brackets: always formatted as ()

property occurrence: syside.conf.OccurrenceKeyword

When occurrence keyword is printed:

• always: occurrence is always printed

• as-needed: occurrence is only printed when required by the grammar

property of: syside.conf.OfKeyword

When of keyword is printed:

• always: of is always printed

• as-needed: of is only printed when required by the grammar

property port: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

When port keyword is printed of default interface ends:

• always: port is always printed

• never: port is never printed

property public: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

When public keyword is printed:

• always: public will always be printed

• never: public will never be printed

property redefines: syside.conf.RedefinesKeyword

Options for redefines keyword formatting.

property ref: syside.conf.RefKeyword

When ref keyword is printed

property references: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between references and ::> when formatting reference subsettings:

• keyword: references is printed

• token: ::> is printed

property requirement: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When requirement keyword is printed in satisfy requirement usages:

• always: requirement is always printed

• as-needed: requirement is only printed when required by the grammar

property specialization: syside.conf.SpecializationKeyword

Options for specialization keyword formatting member relationships (KerML).

When specialization keyword is printed:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property specializes: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between specializes and :> when formatting specializations and subclassifications:

• keyword: specializes is printed

• token: :> is printed

property state: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When state keyword is printed in exhibit state usages:

• always: state is always printed

• as-needed: state is only printed when required by the grammar

property subsets: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between subsets and :> when formatting subsettings:

• keyword: subsets is printed

• token: :> is printed

property succession: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When succession keyword formatting in successions as usages:

• always: succession is always printed

• as-needed: succession is only printed when required by the grammar

property transition: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When transition keyword is printed in transition usages:

• always: transition is always printed if permitted by the grammar

• as-needed: transition is only printed if required by the grammar

property true: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

When true keyword is printed in invariants:

• never: true is never printed

• always: true is always printed if invariant is not negated

property typed_by: syside.conf.FormatPreserved[syside.conf.KwToken]

Choose between typed by and : when formatting feature typings (KerML):

• keyword: typed by is printed

• token: : is printed

property use_case: syside.conf.FormatPreserved[syside.conf.OptionalKw]

When use case keyword is printed in include use case usages:

• always: use case is always printed

• as-needed: use case is only printed when required by the grammar

 Methods

__init__() → None