Table of Contents

Class StaticView

Namespace
C4.Net
Assembly
C4.Net.Core.dll

Serves as the base type for views that render a static structural slice of the model.

[DataContract]
public abstract class StaticView : View
Inheritance
StaticView
Derived
Inherited Members

Properties

Animations

Contains the ordered animation steps configured for this view.

[DataMember(Name = "animations", EmitDefaultValue = false)]
public IList<Animation> Animations { get; }

Property Value

IList<Animation>

Methods

Add(Person)

Adds the given Person to this view.

public void Add(Person person)

Parameters

person Person

The person to add.

Add(Relationship)

Adds a specific relationship to this view.

public RelationshipView Add(Relationship relationship)

Parameters

relationship Relationship

the Relationship to be added

Returns

RelationshipView

a RelationshipView object representing the relationship added

Add(SoftwareSystem)

Adds the given SoftwareSystem to this view.

public virtual void Add(SoftwareSystem softwareSystem)

Parameters

softwareSystem SoftwareSystem

The software system to add.

AddAllElements()

Adds every element type permitted by the concrete static view.

public abstract void AddAllElements()

AddAllPeople()

Adds all people in the model to this view.

public void AddAllPeople()

AddAllSoftwareSystems()

Adds all software systems in the model to this view.

public void AddAllSoftwareSystems()

AddAnimation(params Element[])

Adds an animation step that reveals the supplied elements and the relationships to previously revealed elements.

public void AddAnimation(params Element[] elements)

Parameters

elements Element[]

The elements to reveal in the new animation step.

Exceptions

ArgumentException

Thrown when no elements are supplied or none exist in the view.

AddDefaultElements()

Adds the default set of elements to this view.

public abstract void AddDefaultElements()

AddNearestNeighbours(Element)

Adds the permitted elements that are directly connected to the supplied element.

public abstract void AddNearestNeighbours(Element element)

Parameters

element Element

The element whose neighbourhood should be included.

AddNearestNeighbours(Element, Type) 

protected void AddNearestNeighbours(Element element, Type typeOfElement)

Parameters

element Element
typeOfElement Type

Remove(Person)

Removes the given Person from this view.

public void Remove(Person person)

Parameters

person Person

The person to remove.

Remove(SoftwareSystem)

Removes the given SoftwareSystem from this view.

public void Remove(SoftwareSystem softwareSystem)

Parameters

softwareSystem SoftwareSystem

The software system to remove.