Class DeploymentView

Namespace

C4.Net

Assembly

C4.Net.Core.dll

A deployment view, used to show the mapping of container instances to deployment nodes.

public sealed class DeploymentView : View

Inheritance

object

View

DeploymentView

Inherited Members

View.LayoutMergeStrategy

View.Key

View.SoftwareSystem

View.SoftwareSystemId

View.Description

View.Title

View.PaperSize

View.Dimensions

View.Elements

View.Relationships

View.GetElementView(Element)

View.GetRelationshipView(Relationship)

View.Remove(Relationship)

View.CopyLayoutInformationFrom(View)

View.AutomaticLayout

View.EnableAutomaticLayout()

View.EnableAutomaticLayout(RankDirection, int, int, int, bool)

View.DisableAutomaticLayout()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Animations

Contains the ordered animation steps configured for this deployment view.

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

Property Value

IList<Animation>

Environment

The name of the environment that this deployment view is for (e.g. "Development", "Live", etc).

[DataMember(Name = "environment", EmitDefaultValue = false)]
public string Environment { get; set; }

Property Value

string

Model

Stores the model whose deployment elements participate in this view.

public override Model Model { get; set; }

Property Value

Model

Name

Returns the default name shown for this deployment view.

public override string Name { get; }

Property Value

string

Methods

Add(ContainerInstance)

Adds a container instance (and its parent deployment nodes) to this view.

public void Add(ContainerInstance containerInstance)

Parameters

containerInstance ContainerInstance

the ContainerInstance to add

Add(DeploymentNode)

Adds a deployment node to this view.

public void Add(DeploymentNode deploymentNode)

Parameters

deploymentNode DeploymentNode

the DeploymentNode to add

Exceptions

ArgumentException

Thrown when deploymentNode is null.

Add(DeploymentNode, bool)

Adds a deployment node to this view.

public void Add(DeploymentNode deploymentNode, bool addRelationships)

Parameters

deploymentNode DeploymentNode

the DeploymentNode to add

addRelationships bool

Whether related relationships should be added while walking the deployment tree.

Exceptions

ArgumentException

Thrown when deploymentNode is null.

Add(InfrastructureNode)

Adds an infrastructure node (and its parent deployment nodes) to this view.

public void Add(InfrastructureNode infrastructureNode)

Parameters

infrastructureNode InfrastructureNode

the InfrastructureNode 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

Exceptions

ArgumentException

Thrown when relationship is null.

Add(SoftwareSystemInstance)

Adds a software system instance (and its parent deployment nodes) to this view.

public void Add(SoftwareSystemInstance softwareSystemInstance)

Parameters

softwareSystemInstance SoftwareSystemInstance

the SoftwareSystemInstance to add

AddAllDeploymentNodes()

Adds all of the top-level deployment nodes to this view, for the same deployment environment (if set).

public void AddAllDeploymentNodes()

AddAnimation(params InfrastructureNode[])

Adds an animation step, with the specified infrastructure nodes.

public void AddAnimation(params InfrastructureNode[] infrastructureNodes)

Parameters

infrastructureNodes InfrastructureNode[]

the infrastructure nodes that should be shown in the animation step

Exceptions

ArgumentException

Thrown when infrastructureNodes is empty or null.

AddAnimation(params StaticStructureElementInstance[])

Adds an animation step, with the specified container instances.

public void AddAnimation(params StaticStructureElementInstance[] elementInstances)

Parameters

elementInstances StaticStructureElementInstance[]

the software system/container instances that should be shown in the animation step

Exceptions

ArgumentException

Thrown when elementInstances is empty or null.

AddAnimation(StaticStructureElementInstance[], InfrastructureNode[])

Adds an animation step, with the specified container instances and infrastructure nodes.

public void AddAnimation(StaticStructureElementInstance[] elementInstances, InfrastructureNode[] infrastructureNodes)

Parameters

elementInstances StaticStructureElementInstance[]

the software system/container instances that should be shown in the animation step

infrastructureNodes InfrastructureNode[]

the infrastructure nodes that should be shown in the animation step

Exceptions

ArgumentException

Thrown when both parameter arrays are empty or null.

AddDefaultElements()

Adds the default set of elements to this view.

public void AddDefaultElements()

CheckElementCanBeAdded(Element)

protected override void CheckElementCanBeAdded(Element elementToBeAdded)

Parameters

elementToBeAdded Element

Remove(ContainerInstance)

Removes a container instance from this view.

public void Remove(ContainerInstance containerInstance)

Parameters

containerInstance ContainerInstance

the ContainerInstance to remove

Remove(DeploymentNode)

Removes a deployment node from this view.

public void Remove(DeploymentNode deploymentNode)

Parameters

deploymentNode DeploymentNode

the DeploymentNode to remove

Remove(InfrastructureNode)

Removes an infrastructure node from this view.

public void Remove(InfrastructureNode infrastructureNode)

Parameters

infrastructureNode InfrastructureNode

the InfrastructureNode to remove

Remove(SoftwareSystemInstance)

Removes a software system instance from this view.

public void Remove(SoftwareSystemInstance softwareSystemInstance)

Parameters

softwareSystemInstance SoftwareSystemInstance

the SoftwareSystemInstance to remove