Element

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > 要素 >

Element

Elementは基本的なモデル要素の単位です。Elementは、クラス・ユースケース・ノード・コンポーネントなどに対応します。PackageのElementsコレクションに追加する形で新しい要素を追加します。新しい要素を作成した後には、ダイアグラムのDiagramObjectsコレクションに追加することで、ダイアグラムに追加することができます。

 

要素はConnectorsコレクションも保持しています。コレクションのそれぞれのConnectorは別の要素への接続を表しています。

 

また、要素に関連する追加のプロパティを管理するためのコレクションも保持しています。具体的には、TaggedValues, Issues, Constraints, Requirement などがあります。

 

プロジェクト内の関係するテーブル: t_object

 

属性

属性

R/W

説明

Abstract

string

RW

要素が抽象要素であるかどうかを示します。

抽象要素の場合には、true(1)になります。 抽象要素ではない場合には、false(0)です。

ActionFlags

string

RW

状態要素のアクションについての情報を保持します。

Alias

string

RW

この要素の別名です。

AssociationClassConnectorID

int

R

要素が関連クラスの場合に、関連クラスが関係している接続のConnectorIDが格納されます。

関連クラスの作成については、 CreateAssociationClass() をご覧ください。
(ビルド904以降で利用可能)

Attributes

Collection

(Attribute)

R

現在の要素に定義されている属性のコレクションです。

属性の追加と削除を行う場合、このコレクションに対して AddNew あるいは Delete を実行します。

AttributesEx

Collection

(Attribute)

R

現在の要素とその親要素に定義されている属性のコレクションです。

Author

string

RW

要素の作者です。

BaseClasses

Collection

(Element)

R

親となるクラスの一覧です。

ClassfierID

int

R

利用非推奨です。ClassifierIDを利用してください。

ClassifierID

int

RW

要素の分類子のElementIDです。要素がオブジェクトである場合にのみ有効です。

過去との互換性を維持するため、ClassfierIDという属性もあります。これらの内容は同じです。

ClassifierName

string

RW

分類子の名前です。

ClassifierType

string

R

要素に関連する分類子の種類です。

Complexity

string

RW

要素がどの程度複雑であるかどうかを示します。この値は見積もりなどに利用されます。

有効な値は次の通りです。

1 容易 2 普通 3 困難

CompositeDiagram

Diagram

R

要素に子ダイアグラムがある場合に、そのダイアグラムを返します。子ダイアグラムがない場合にはNULLを返します。

(ビルド832以降で利用可能)

Connectors

Collection

(Connector)

R

要素に関係する接続のコレクションです。

Constraints

Collection

(Constraint)

RW

現在の要素に定義されている制約のコレクションです。

ConstraintsEx

Collection

(Constraint)

R

現在の要素とその親要素に定義されている制約のコレクションです。

Created

DateTime

R

要素の生成日です。

CustomProperties

Collection

(CustomProperty)

R

要素の追加属性(追加プロパティ)の情報です。一部の要素のみが対象です。

Enterprise Architectの要素のプロパティダイアログで、「追加属性」グループが表示される要素の場合には、このCustomPropertiesコレクションで値を取得・設定できます。

Diagrams

Collection

(Diagram)

R

モデルブラウザにおける子ダイアグラムのコレクションです。

Difficulty

string

RW

要素の難易度を指定します。要求要素・変更要素・問題要素・ユーザー機能要素・リスク要素・タスク要素にのみ適用できます。

有効な値は次の通りです。

1 低 2 普通 3 高

Efforts

Collection

(Effort)

R

現在の要素に設定されている作業のコレクションです。

ElementGUID

string

R

要素のGUIDです。このIDは全てのモデル内で一意になっています。この値を変更することはできません。

ElementID

int

R

要素のIDです。システムが設定します。

Elements

Collection

(Element)

R

要素の子要素のコレクションです。

EmbeddedElements

Collection

(Element)

R

要素に関係する付属要素の一覧です。

EventFlags

string

RW

状態要素のシグナルやイベントについての情報を保持します。

ExtensionPoints

string

RW

ユースケースの拡張点です。カンマで区切られて返されます。

Files

Collection

(File)

R

現在の要素に設定されているファイルのコレクションです。

FQName

string

R

名前空間の情報も含めた、要素の名前です。

(ビルド1300以降で利用可能)

FQStereotype

string

R

ステレオタイプが定義されているプロファイル名も含む、ステレオタイプ名を返します。

例: ProfileName::StereotypeName

(ビルド1220以降で利用可能)

Genfile

string

 

RW

コード生成時と同期時のファイル名とファイルパスです。「ローカルパス」機能のマクロを含む場合もあります。

ローカルパスの設定情報は、Windows標準の「Application Data」ディレクトリ以下の「Sparx Systems¥EA」ディレクトリ内にある「paths.txt」ファイルに格納されています。

Genlinks

string

RW

ソースコードの解析時に発見された他のクラスへのリンク情報です。親クラスとInterfaceが含まれます。

Gentype

string

 

RW

コード生成時のプログラム言語です。

例: Java, C++, C#, VBNet, Visual Basic, Delphi

Header1

object

RW

ヘッダファイルに追加されるヘッダ情報です。

Header2

object

RW

ソースファイルに追加されるヘッダ情報です。

IsActive

bool

RW

要素のIs Activeプロパティに対応します。

IsComposite

bool

RW

要素に子ダイアグラムがあるかどうかを示します。
(ビルド904以降で利用可能)

IsLeaf

bool

RW

要素のIs Leafプロパティに対応します。

IsRoot

bool

RW

要素のIs Rootプロパティに対応します。
(ビルド1220以降で利用可能)

IsNew

bool

RW

要素のIs Newプロパティに対応します。

IsSpec

bool

RW

要素のIs Specプロパティに対応します。

Issues

Collection

(Issue)

R

現在の要素に設定されている問題のコレクションです。

Locked

bool

RW

要素がロックされているかどうかを示します。

MetaType

string

R

UMLプロファイルで定義した要素の、要素の種類を示す文字列です。(_metataypeの定義で設定された値です。)

Methods

Collection

(Method)

R

現在の要素に定義されている操作のコレクションです。操作の追加と削除を行う場合、このコレクションに対してAddNewあるいはDeleteを実行します。

MethodsEx

Collection

(Method)

R

現在の要素とその親要素に定義されている操作のコレクションです。

Metrics

Collection

(Metric)

R

現在の要素に設定されている測定方法のコレクションです。

MiscData

string

R

このプロパティは、Enterprise Architect内部で利用されている内部データを直接参照するための属性です。

MiscData[0]は、内部テーブルの「PDATA1」フィールドに含まれている内容を返します。

同様にして、PDATA5フィールドに対応するMiscData[4]までが利用できます。

Modified

DateTime

R

要素の最終変更日時です。

Multiplicity

string

RW

この要素の多重度です。

Name

string

RW

要素の名前です。

Notes

string

RW

要素についてのノートです。

ObjectType

ObjectType

R

オブジェクトを区別するために利用できる、このオブジェクトの種類です。

PackageID

int

RW

要素が属するパッケージのIDです。

ParentID

int

RW

この要素が他の要素の子になっている場合には、親を指します。そうでない場合には0になっています。

Partitions

Collection

(Partition)

R

要素内に定義されたパーティション(領域・区画)の情報です。読み取り専用です。アクティビティ要素や状態要素など、一部の要素のみが対象です。

なお、タイミング図のライフラインの状態もこのコレクションに格納されています。

Persistence

string

RW

要素の持続性を指定します。PersistentTransient で指定します。

Phase

string

RW

要素に関連するフェーズ情報です。

Priority

string

RW

要素の相対的な優先度を指定します。要求要素・変更要素・問題要素・ユーザー機能要素・リスク要素・タスク要素にのみ適用できます。

有効な値は次の通りです。

1 低 2 普通 3 高

Properties

Properties

RW

この要素に定義されたプロパティ情報を返します。

このプロパティ情報として取得できる内容は、ヘルプには記載されていません。バージョン・ビルドにより、取得可能な内容の量は異なります。

PropertyType

int

RW

ポートやパートの型のElementIDです。それ以外の種類の要素については、値は設定されません。

Repository.GetElementByIDを利用して関係する要素を取得します。

PropertyTypeName

string

R

ポートやパートの型の名前です。それ以外の種類の要素については、値は設定されません。

(ビルド1100以降で利用可能)

Realizes

Collection
(Element)

R

この要素によって実現される要素のコレクションです。

Requirements

Collection
(Requirement)

R

現在の要素に定義されている内部の要求のコレクションです。

外部の要求要素はこのコレクションに含まれません。

Connectorsコレクションから、実現の接続で結ばれる要求要素を取得する必要があります。

RequirementsEx

Collection
(Requirement)

R

現在の要素とその親要素に定義されている内部の要求のコレクションです。

Resources

Collection
(Resource)

R

現在の要素に割り当てられているリソースのコレクションです。

Risks

Collection
(Risk)

R

現在の要素に設定されているリスクのコレクションです。

RunState

string

RW

現在の要素に設定されている属性値(スロット)の値です。

(ビルド813以降で利用可能)

 

この文字列の構成は次のようになっています。

'@VAR;Variable=<string>;Value=<string>;Op=<string>;@ENDVAR;'

 

ここで、Op = ['=','>','<','>=','<=', '!=','<>'] です。

Scenarios

Collection
(Scenario)

R

現在の要素に定義されているシナリオのコレクションです。

StateTransitions

Collection
(Transition)

R

タイミング図でのみ利用できる、状態遷移についての情報です。一部の要素のみが対象です。

Status

string

RW

要素の状態です。

Stereotype

string

RW

要素に定義されたステレオタイプです。

(ステレオタイプを削除する(空文字を設定する)場合はStereotypeExをご利用ください。)

設定後にUpdateする場合に、エラーがあった場合にはGetLastError()で情報を取得できます。

StereotypeEx

string

RW

要素に定義されたステレオタイプをカンマで区切った文字列です。

設定後にUpdateする場合に、エラーがあった場合にはGetLastError()で情報を取得できます。

StyleEx

string

RW

追加のスタイル設定です。現在は利用されていません。

Subtype

int

RW

サブタイプの情報を指定します。有効な値は次の通りです。括弧内はType属性の文字列です。

 

  • イベント(Event):
    0 = シグナル送信, 1 = イベント受信, 2 = 時間イベント
  • クラス(Class):
    1 = パラメタライズドクラス, 2 = インスタンス化されたクラス, 3 = 両方, 0 = どちらでもない,17 = 関連クラス
  • ノート(Note):
    1= 接続に付加されたノート, 2 = 接続に付加された制約
  • アクティビティ図/ステートマシン図の要素(StateNode):
    3 = 開始状態, 4 = 終了状態, 5 = 履歴状態, 6 = 同期状態, 10 = 連結点, 11 = 選択点, 12 = 停止状態, 13 = 入場点, 14 = 退場点, 15 = 深い履歴状態, 100= 開始, 101 = 終了, 102 = フロー終了
  • パッケージ(Package):
    20=パッケージコンポーネント
  • テキスト(Text):
    18=ダイアグラムの概要ノート 19=ハイパーリンク 76=凡例
  • タイミング図のライフライン(TimeLine):
    0=状態ライフライン 1=汎用値ライフライン
  • その他の要素:
    8 = 子ダイアグラムがある
  • フォーク/ジョイン(Synchronization):
    0= 水平, 1 = 垂直
  • 複合フラグメント(InteractionFragment)
    0= alt, 1 = opt, 2 = break, 3 = par, 4 = loop, 5 = critical, 6 = neg, 7 = assert, 8 = strict, 9 = seq, 10 = ignore, 11 = consider

Tablespace

string

RW

Table要素の場合に利用されるテーブルスペース情報です。

Tag

string

RW

検索に利用される「キーワード」です。

TaggedValues

Collection
(TaggedValue)

R

現在の要素に定義されているタグ付き値のコレクションです。

TaggedValuesEx

Collection
(TaggedValue)

R

現在の要素とその親要素に定義されているタグ付き値のコレクションです。

TemplateParameters

Collection
(TemplateParameter)

R

現在の要素に定義されているテンプレートパラメータのコレクションです。(ビルド1100以降で利用可能)

Tests

Collection
(Test)

RW

現在の要素に設定されているテスト項目のコレクションです。

TreePos

int

RW

モデルブラウザにおける要素の位置です。モデルブラウザ内の上下位置がユーザーによって変更されていない場合には、0になっています。

Type

string

RW

要素の種類です。なお、大文字小文字を区別しますので注意してください。

有効な文字列はこちらをご覧ください

TypeInfoProperties

TypeInfoProperties

R

TypeInfoPropertiesを参照する場合に利用します。

(ビルド1500以降で利用可能)

Version

string

RW

この要素のバージョンです。

Visibility

string

RW

現在のパッケージにおける要素の可視性です。

有効な値は次の通りです。

Public, Private, Protected, Package

 

 

操作

操作

戻り値の型

説明

ApplyGroupLock

(string aGroupName)

bool

この要素に対して、グループを指定してグループロックを設定します。

ロックの設定に成功した場合には、trueが、失敗した場合にはfalseが戻ります。GetLastErrorで失敗原因を確認できます。

(ビルド832以降で利用可能)

 

引数:

  • aGroupName: string - ロックする対象のグループの名前です。

ApplyUserLock()

bool

この要素に対して、現在のユーザーでユーザーロックを設定します。

ロックの設定に成功した場合には、trueが、失敗した場合にはfalseが戻ります。GetLastErrorで失敗原因を確認できます。

(ビルド832以降で利用可能)

Clone()

Element

同じ内容の要素を複製します。複製した要素も、元の要素と同じパッケージに格納されます。

 

戻り値は、複製後の要素です。

(ビルド1300以降で利用可能)

CreateAssociationClass

(int ConnectorID)

 

bool

対象のクラス要素を関連クラスとして、既存の関連に結びつけます。戻り値は、処理が成功したかどうかを示します。

成功するかどうかは、以下の条件を満たすことが必要です。

  • 指定された要素が存在する
  • 要素の種類がクラスである
  • 対象の要素がすでに関連クラスでない
  • 指定された接続が存在する
  • 接続の種類が関連である
  • 対象の接続がすでに関連クラスに関連づけられていない
  • 対象の要素が、指定された関連のいずれの端でもない

 

引数:

  • ConnectorID: int - 関連づけるConnectorのIDです。

(ビルド904以降で利用可能)

 

参考:UnlinkFromAssociation

DeleteLinkedDocument()

bool

付属ドキュメントを削除します。この機能を実行時には、確認のダイアログが表示されずに、削除されます。

(ビルド1100以降で利用可能)

 

削除に成功するとtrueが返ります。

ExportInternalDocumentArtifact

(string FilePath)

bool

対象の成果物要素が埋め込みで保持する外部ファイルを指定したパスに出力します。成功するとtrueが戻ります。

成果物(Artifact)要素でのみ利用できます。

(ビルド1212以降で利用可能・コーポレート版以上で利用可能)

 

引数:

  • FilePath: string - 出力先となるファイルパスを指定します。

GetBusinessRules()

string

対象の要素に定義された、すべてのビジネスルールの内容を返します。

(ビルド1100以降で利用可能)

GetDecisionTable()

string

対象の要素に設定されたデシジョンテーブルの内容をXML形式で返します。

(ビルド1310以降で利用可能)

GetElementGrid()

ElementGrid

表要素の内容を取得します。

(ビルド1500以降で利用可能)

GetLastError()

string

最後に発生したエラーの詳細情報です。

エラーが発生したときには例外が発生しますので、この操作を利用することはほとんどありません。

GetLinkedDocument()

string

付属ドキュメントの内容を取得します。

付属ドキュメントがない場合には空文字列を返します。

(ビルド801以降で利用可能)

GetRelationSet

(EnumRelationSetType Type)

string

指定された種類に該当する要素のElementIDを、カンマ区切りで返します。

該当する要素に対して、さらに指定した種類の接続でつながる要素がある場合、その要素も対象になります。例えば、Object1からObject2に接続があり、同種の接続がObject2からObject3にある場合には、Object2およびObject3が戻ります。

直接関係する要素のみを取得したい場合には、Connectorコレクションを利用してください。

EnumRelationSetTypeもご覧ください。

GetStereotypeList()

string

対象の要素に関連付けられているステレオタイプの一覧をカンマで区切って返します。

HasStereotype

(string stereotype)

bool

対象の要素が、指定されたステレオタイプを継承した要素かどうかを返します。

(ビルド1200以降で利用可能)

ImportInternalDocumentArtifact

(string FilePath)

bool

対象の成果物要素に外部ファイルを埋め込み、プロジェクト内にそのファイルを保持します。成功するとtrueが戻ります。

成果物(Artifact)要素でのみ利用できます。

(ビルド1212以降で利用可能・コーポレート版以上で利用可能)

 

引数:

  • FilePath: string - 対象のファイルパスを指定します。

IsAssociationClass

bool

要素が関連クラスかどうかを返します。

(ビルド904以降で利用可能)

IsInternalDocArtifact

bool

対象の要素が、外部ファイルを埋め込みで保持する成果物要素かどうかを返します。

(ビルド1212以降で利用可能)

LoadLinkedDocument

(string FileName)

bool

読み込みに成功した場合にはTrueが返ります。Trueが戻った場合には、Updateメソッドを実行し、変更されたプロパティを保存してください。

(ビルド813以降で利用可能・DOCXファイルへの対応はビルド1210以降で利用可能)

 

引数:

  • FileName: string - 指定されたRTFファイルあるいはDOCXファイルから内容を読み取り、付属ドキュメントとして設定します。

 

参考:要素の付属ドキュメント

Refresh()

なし

プロジェクトから要素の情報を再取得します。

ReleaseUserLock()

bool

この要素に設定されたユーザーロックやグループロックを解除します。

ロックの解除に成功した場合にはtrueが、失敗した場合にはfalseが戻ります。GetLastErrorで失敗原因を確認できます。

(ビルド832以降で利用可能)

SaveLinkedDocument

(string FileName)

bool

要素の付属ドキュメントの内容を、指定されたファイルに保存します。保存に成功した場合にはTrueが返ります。

(ビルド813以降で利用可能)

ファイルの拡張子によって、DOCXファイル・PDFファイル・RTFファイルとして保存できます。

 

引数:

  • FileName: string - 出力先を指定します。

SetAppearance

(int Scope,

int Item,

int Value)

int

要素の書式を設定します。

 

引数:

  • Scope: int -変更する範囲を指定します。常に1を指定します。

1- 全てのダイアグラム(要素の既定値)

 

ダイアグラムごとの書式を設定したい場合には、対象のダイアグラムに関係づけられたDiagramObjectの属性を変更します。

 

  • Item: int -対象の項目を指定します。

0-背景色

1-フォントの色

2-境界色

3-境界の幅

 

  • Value: int -対象の値を指定します。
    色の数値の指定方法は色の値の指定の項目をご覧ください。

SetCompositeDiagram

(string GUID)

bool

要素の子ダイアグラムを指定、あるいは解除します。

(ビルド1100以降で利用可能)
 

引数:

  • GUID: string - 対象のダイアグラムのGUIDを指定します。空文字列を指定した場合には、子ダイアグラムとの結びつけを解除します。

SetCreated

(DateTime NewVal)

なし

この操作は利用できません。

(過去との互換性のために、定義が残されています。)

SetModified

(DateTime NewVal)

なし

この操作は利用できません。

(過去との互換性のために、定義が残されています。)

SynchConstraints

(string Profile,

string Stereotype)

bool

UMLプロファイルで定義されたステレオタイプに対して、制約に関する情報が最新の内容になるように、一括更新します。
(ビルド1000以降で利用可能)
 

引数:

  • Profile: string - 対象のステレオタイプが定義されたUMLプロファイルの名前を指定します。
  • Stereotype: string - 対象のステレオタイプの名前を指定します。

SynchTaggedValues

(string Profile,

string Stereotype)

bool

UMLプロファイルで定義されたステレオタイプに対して、タグ付き値に関する情報が最新の内容になるように、一括更新します。
(ビルド1000以降で利用可能)

 

引数:

  • Profile: string - 対象のステレオタイプが定義されたUMLプロファイルの名前を指定します。
  • Stereotype: string - 対象のステレオタイプの名前を指定します。

UnlinkFromAssociation()

bool

関連クラスとして定義済みのクラスに対して実行することで、関連クラスを解除することができます。
(ビルド904以降で利用可能)

参考:CreateAssociationClass

Update()

bool

既存の要素を変更した場合や新しい要素を追加した場合に更新するメソッドです。

Falseが返された場合にはGetLastErrorメソッドで詳細な情報を取得することができます。

 

要素の種類名

次の表は、Enterprise Architectで、要素の種類として利用可能な単語とその対象の要素についてまとめたものになります。過去のバージョンからの互換性や翻訳の問題などにより、英単語とその対応する要素がイメージしづらいものもあります。

 

単語

対応する要素

Action

アクション

ActionPin

アクションピン

Activity

アクティビティ

ActivityParameter

アクティビティパラメータ

ActivityPartition

アクティビティパーティション

ActivityRegion

アクティビティ領域

Actor

アクター

Artifact

成果物

Association

N項関連(の菱形)

Boundary

バウンダリ

CentralBufferNode

中央バッファノード

Change

変更

Class

クラス

Collaboration

コラボレーション

CollaborationOccurrence

コラボレーションの利用

Component

コンポーネント

ConditionalNode

条件ノード

Constraint

制約

DataStore

データストア

DataType

データ型

Decision

デシジョン

DeploymentSpecification

配置仕様

Device

デバイス

DiagramFrame

ダイアグラムフレーム

EmbeddedElement

付属要素(現在未使用)

Entity

エンティティ

EntryPoint

入場点

Enumeration

列挙

Event

イベント

ExceptionHandler

例外ハンドラ

ExecutionEnvironment

実行環境

ExitPoint

退場点

ExpansionNode

拡張ノード

ExpansionRegion

拡張領域

Feature

ユーザー機能

GUIElement

GUI要素

InformationItem

情報アイテム

Interaction

相互作用

InteractionFragment

複合フラグメント

InteractionOccurrence

相互作用の利用

InteractionState

状態不変式/継続

Interface

インターフェース

InterruptibleActivityRegion

割込み可能アクティビティ領域

Issue

問題

LoopNode

ループノード

MergeNode

マージノード

MessageEndpoint

メッセージ終了点

Node

ノード

Note

ノート

Object

オブジェクト

ObjectNode

オブジェクトノード

Package

パッケージ

Parameter

アクティビティパラメータ

Part

パート (プロパティ)

Port

ポート

ProtocolStateMachine

プロトコル状態マシン

ProvidedInterface

提供インターフェース

Report

レポート(現在未使用)

RequiredInterface

要求インターフェース

Requirement

要求

Risk

リスク

Screen

画面

Sequence

シーケンス図のライフライン

Signal

シグナル

State

状態

StateMachine

状態マシン

StateNode

開始状態・終了状態

Synchronization

フォーク・ジョイン

Task

タスク

Text

テキスト

TimeLine

タイミング図のライフライン

Trigger

トリガ

UMLDiagram

UMLダイアグラム

UseCase

ユースケース