Class StaticStructureElement

Namespace

C4.Net

Assembly

C4.Net.Core.dll

This is the superclass for model elements that describe the static structure of a software system, namely Person, SoftwareSystem, Container and Component.

public abstract class StaticStructureElement : GroupableElement

Inheritance

object

ModelItem

Element

GroupableElement

StaticStructureElement

Derived

Component

Container

Person

SoftwareSystem

Inherited Members

GroupableElement.Group

Element.Name

Element.Description

Element.Url

Element.Model

Element.Relationships

Element.CanonicalName

Element.Parent

Element.Has(Relationship)

Element.HasAfferentRelationships()

Element.HasEfferentRelationshipWith(Element)

Element.HasEfferentRelationshipWith(Element, string)

Element.GetEfferentRelationshipsWith(Element)

Element.GetEfferentRelationshipWith(Element)

Element.GetEfferentRelationshipWith(Element, string)

Element.ToString()

Element.Equals(object)

Element.Equals(Element)

ModelItem.Id

ModelItem.GetAllTags()

ModelItem.GetTagsAsSet()

ModelItem.Tags

ModelItem.AddTags(params string[])

ModelItem.RemoveTag(string)

ModelItem.GetRequiredTags()

ModelItem.Properties

ModelItem.AddProperty(string, string)

ModelItem.Perspectives

ModelItem.AddPerspective(string, string)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Methods

Delivers(Person, string)

Adds a unidirectional relationship between this element and a person.

public Relationship Delivers(Person destination, string description)

Parameters

destination Person

the target of the relationship

description string

a description of the relationship (e.g. "sends e-mail to")

Returns

Relationship

The created relationship.

Delivers(Person, string, string)

Adds a unidirectional relationship between this element and a person.

public Relationship Delivers(Person destination, string description, string technology)

Parameters

destination Person

the target of the relationship

description string

a description of the relationship (e.g. "sends e-mail to")

technology string

the technology details (e.g. JSON/HTTPS)

Returns

Relationship

The created relationship.

Delivers(Person, string, string, InteractionStyle?)

Adds a unidirectional relationship between this element and a person.

public Relationship Delivers(Person destination, string description, string technology, InteractionStyle? interactionStyle)

Parameters

destination Person

the target of the relationship

description string

a description of the relationship (e.g. "sends e-mail to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

Returns

Relationship

The created relationship.

Delivers(Person, string, string, InteractionStyle?, string[])

Adds a unidirectional "uses" style relationship between this element and a person

public Relationship Delivers(Person destination, string description, string technology, InteractionStyle? interactionStyle, string[] tags)

Parameters

destination Person

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

tags string[]

an array of tags

Returns

Relationship

The created relationship.

Uses(Component, string)

Adds a unidirectional "uses" style relationship between this element and a component.

public Relationship Uses(Component destination, string description)

Parameters

destination Component

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

Returns

Relationship

The created relationship.

Uses(Component, string, string)

Adds a unidirectional "uses" style relationship between this element and a component.

public Relationship Uses(Component destination, string description, string technology)

Parameters

destination Component

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

Returns

Relationship

The created relationship.

Uses(Component, string, string, InteractionStyle?)

Adds a unidirectional "uses" style relationship between this element and a component.

public Relationship Uses(Component destination, string description, string technology, InteractionStyle? interactionStyle)

Parameters

destination Component

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

Returns

Relationship

The created relationship.

Uses(Component, string, string, InteractionStyle?, string[])

Adds a unidirectional "uses" style relationship between this element and a component

public Relationship Uses(Component destination, string description, string technology, InteractionStyle? interactionStyle, string[] tags)

Parameters

destination Component

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

tags string[]

an array of tags

Returns

Relationship

The created relationship.

Uses(Container, string)

Adds a unidirectional "uses" style relationship between this element and a container.

public Relationship Uses(Container destination, string description)

Parameters

destination Container

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

Returns

Relationship

The created relationship.

Uses(Container, string, string)

Adds a unidirectional "uses" style relationship between this element and a container.

public Relationship Uses(Container destination, string description, string technology)

Parameters

destination Container

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

Returns

Relationship

The created relationship.

Uses(Container, string, string, InteractionStyle?)

Adds a unidirectional "uses" style relationship between this element and a container.

public Relationship Uses(Container destination, string description, string technology, InteractionStyle? interactionStyle)

Parameters

destination Container

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (Synchronous or Asynchronous)

Returns

Relationship

The created relationship.

Uses(Container, string, string, InteractionStyle?, string[])

Adds a unidirectional "uses" style relationship between this element and a container

public Relationship Uses(Container destination, string description, string technology, InteractionStyle? interactionStyle, string[] tags)

Parameters

destination Container

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

tags string[]

an array of tags

Returns

Relationship

The created relationship.

Uses(SoftwareSystem, string)

Adds a unidirectional "uses" style relationship between this element and a software system.

public Relationship Uses(SoftwareSystem destination, string description)

Parameters

destination SoftwareSystem

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

Returns

Relationship

The created relationship.

Uses(SoftwareSystem, string, string)

Adds a unidirectional "uses" style relationship between this element and a software system.

public Relationship Uses(SoftwareSystem destination, string description, string technology)

Parameters

destination SoftwareSystem

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

Returns

Relationship

The created relationship.

Uses(SoftwareSystem, string, string, InteractionStyle?)

Adds a unidirectional "uses" style relationship between this element and a software system.

public Relationship Uses(SoftwareSystem destination, string description, string technology, InteractionStyle? interactionStyle)

Parameters

destination SoftwareSystem

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

Returns

Relationship

The created relationship.

Uses(SoftwareSystem, string, string, InteractionStyle?, string[])

Adds a unidirectional "uses" style relationship between this element and a software system.

public Relationship Uses(SoftwareSystem destination, string description, string technology, InteractionStyle? interactionStyle, string[] tags)

Parameters

destination SoftwareSystem

the target of the relationship

description string

a description of the relationship (e.g. "uses", "gets data from", "sends data to")

technology string

the technology details (e.g. JSON/HTTPS)

interactionStyle InteractionStyle?

the interaction style (sync vs async)

tags string[]

an array of tags

Returns

Relationship

The created relationship.