IModel Interface
Namespace: NextDesign.Core
Description
Provides access to NextDesign's design model information.
Area
| Name | Description |
|---|---|
| Model | APIs for accessing the model. |
Inherit Base
| Name | Description |
|---|---|
| IObject | Represents an identifiable object. |
Derived From
| Name | Description |
|---|---|
| IFrame | Object for accessing frame information. |
| IInteractionElement | This is an access object for interaction model element information. Defines common characteristics for elements that represent interactions. |
| IFeature | This is an access object for product feature information. |
| IProductLineModel | This is an access object for the product line development support model. |
| IConfigurationModel | This is an access object for the product configuration model. |
| IProject | Provides a means of accessing project information. |
| IInteraction | This is an access object for interaction model information. |
| IFeatureModel | Access object for the management model that structures product features. |
| IRelationship | Access object for related information. |
| IProduct | Access object for product information. |
Property
| Name | Description |
|---|---|
| ClassName | Class name Gets the name of the Metaclass. |
| Description | Description |
| Errors | Gets the collection of error information for this model. Error information includes summary information. |
| HasError | Checks if this model has errors. Returns True if this model has errors. This evaluation includes summary information. |
| HasErrorWithChildren | Checks if this model and its child elements and their sub-elements have errors. Returns True if this model and its child elements and their sub-elements have errors. This evaluation includes summary information. |
| IsDeleted | Checks if this instance has been deleted. |
| IsDeleting | Checks if this model is being deleted. |
| IsDirty | Checks if this model is in a dirty state (unsaved). Returns True if not saved. |
| IsEditable | Checks if this instance is editable. |
| IsProductLineElement | Checks if this model is a product line model. |
| IsProxy | Checks if this instance is a proxy element. A proxy element is generated in a distributed environment if the unit that recorded this instance information has not been loaded. |
| IsUnitTopModel | Checks if this instance is the base model for a unit. |
| ModelPath | Model hierarchy path of this instance Returns a path string concatenated with a path separator ("/"), starting from the model root, product line, or unit base model whose parent element has not been loaded. If the root node to which this instance belongs is a model whose parent element has not been loaded, "\partial;" is added to the beginning of the path string concatenated with a path separator. |
| ModelUnit | Unit (physical file) information that manages this instance information |
| Name | Name |
| Owner | Model that directly owns this instance Returns null if this instance is related or if there is no owning model. |
| OwnerProject | The project that holds this instance |
Method
| Name | Description |
|---|---|
| AddError | Adds error information to this model and returns the added error information. |
| AddNewModel | Adds an instance of the specified class as a field value to the specified field of this instance. The instance is added as the last element of the field. Even if the specified class is an abstract class, instantiation is allowed and it is added as the last element of the field. The specified field must be an owned field of a class type. No exception is thrown if the multiplicity limit constraint of a field with multiplicity of 2 or more is violated. Also, the specified class name must be of a type compatible with the data type of the field. Note that when using fuzzy matching, if there are multiple matching classes, the first type-compatible class instance found will be added. |
| AddNewModelAt | Adds an instance of the specified class as a field value to the specified field of this instance, specifying the addition position. Even if the specified class is an abstract class, instantiation is allowed and it will be added as a field value to the specified position. The specified field must be an owned field of the class type. Note that no exception will be thrown even if the multiplicity limit constraint of a field with multiplicity of 2 or more is violated. The specified class name must be of a type compatible with the data type of the field. Also, when using fuzzy matching, if there are multiple matching classes, the first type-compatible class instance found will be added. |
| AddNewModelTo | Adds an instance of the specified class as a field value to the specified field of this instance, specifying the addition position. Even if the specified class is an abstract class, instantiation is allowed and it is added as a field value at the specified location. The specified field must be an owned field of the class type. Note that no exception is thrown even if the multiplicity limit constraint of a field with multiplicity of 2 or more is violated. The specified class name must be of a type compatible with the data type of the field. Also, when performing a fuzzy match, if there are multiple matching classes, the instance of the first type-compatible class found is added. |
| As(IClass) | Checks if this instance is compatible with the specified class type. Returns True if this instance is an instance of the specified class or its subclass. |
| As(IPackage,string,bool) | Checks if this instance is compatible with the specified class type. The specified class is identified from under the package specified in the scope. Returns True if this instance is an instance of the specified class or its subclass. See the IModel documentation for how to specify class names and fuzzy matching options. |
| As(string,bool) | Checks if this instance is compatible with the specified class type. Returns True if this instance is an instance of the specified class or its subclass. See the IModel documentation for how to specify class names and fuzzy matching options. |
| AsIn(IEnumerable<IClass>) | Checks if this instance is compatible with any of the specified class types. Returns True if this instance is an instance of any of the specified classes or their subclasses. |
| AsIn(IEnumerable<string>,bool) | Checks if this instance is compatible with any of the specified class types. Returns True if this instance is an instance of one of the specified classes or their subclasses. See the IModel documentation for how to specify class names and fuzzy matching options. |
| AsIn(IPackage,IEnumerable<string>,bool) | Checks if this instance is compatible with one of the specified class types. Specified classes are identified from under the package specified in the scope. Returns True if this instance is an instance of one of the specified classes or their subclasses. See the IModel documentation for how to specify class names and fuzzy matching options. |
| AsIn(IPackage,string,bool) | Checks if this instance is compatible with one of the specified class types. Specified classes are identified from under the package specified in the scope. Returns True if this instance is an instance of one of the specified classes or their subclasses. See the IModel documentation for how to specify class names and fuzzy matching options. |
| AsIn(string,bool) | Checks if this instance is compatible with one of the specified class types. Returns True if this instance is an instance of one of the specified classes or their subclasses. See the IModel documentation for how to specify class names and fuzzy matching options. |
| AssignFeature | Assigns the specified feature to this model. |
| AssignFeatureByName | Assigns the feature with the specified name to this model. |
| AssignFeatures | Assigns all the specified features to this model. |
| AssignFeaturesByName | Assigns all the features with the specified name to this model. |
| CanChangeMetaclassTo | Determines whether the class of this model can be changed to the specified class. Returns false if the parent model can no longer hold this model as a result of the class change. If this model is related, returns false if the related end model can no longer hold it. |
| CanRelate | Checks whether the specified field of this instance can be associated with the specified model. Returns True if it can be associated. This method evaluates not only the field type but also the following field constraints: [Constraints to evaluate] - Path constraints - Type constraints - Multiplicity limit Note that it returns False if it or the associated model is a deleted model or a temporary proxy. It also returns False if the following fields are specified: - Product line feature assignment fields - Fields tagged with System.Core - Owned fields - Invalid fields |
| CanRelateAny | Checks whether this instance can be associated with the specified model. It returns True if it can be associated with any of the reference fields of this instance. Note that it returns False if it or the associated model is a deleted model or a temporary proxy. Owned fields are not included. |
| ChangeMetaclassTo | Changes the class of this model to the specified class. If the class of the ownership-related instances with the parent model becomes unavailable due to the class change of the model, the class of the ownership-related instances will be changed to the first class found. Also, field values that cannot be maintained in the changed class will be deleted. Shapes that cannot be maintained in the changed class will be deleted. |
| Count | Gets the number of values for the specified field. This method does not evaluate IContextOption.PlModelAccessMode. |
| CreateAsyncValidationContext | Creates an asynchronous validation context for this model. |
| Delete | Deletes this instance. Nothing happens if this method is called on an instance that has already been deleted. Deleting this instance will result in the following changes to the model: - The ownership relationship between this instance and its owner (parent element) will be removed. - All reference relationships with this instance as the end of the relationship will be removed. - All child elements owned by this instance and their sub-elements, as well as reference relationships with those elements as the end of the relationship, will be removed. |
| FindChildrenByClass(IClass,bool) | Searches for instances of the specified class among the instances owned by this instance. This method evaluates IContextOption.PlModelAccessMode. |
| FindChildrenByClass(IPackage,string,bool,bool) | Searches for instances of the specified class among the instances owned by this instance. The specified class is identified from under the package specified in the scope. This method evaluates IContextOption.PlModelAccessMode. It returns a collection of instances of the specified class among the instances that own it. If the class specified in the class name is not found, it returns an empty collection. It also returns an empty collection if no corresponding instances exist. |
| FindChildrenByClass(string,bool,bool) | Searches for instances of the specified class among the instances that own this instance. This method evaluates IContextOption.PlModelAccessMode. It returns a collection of instances of the specified class among the instances that own it. If the class specified in the class name is not found, it returns an empty collection. It also returns an empty collection if no corresponding instances exist. |
| FindChildrenByClassDisplayName | Searches for instances of the class with the specified display name among the instances owned by this instance. This method evaluates to IContextOption.PlModelAccessMode. Returns a collection of instances of the class with the specified display name among the instances owned by this instance. Returns an empty collection if no matching instances are found. |
| FindChildrenByClassTag | Retrieves instances of the class with the specified tag among the instances owned by this instance. This method evaluates to IContextOption.PlModelAccessMode. Returns a collection of instances of the class with the specified tag among the instances owned by this instance. Returns an empty collection if no matching instances are found. |
| FindChildrenByTag | Retrieves instances of the specified tag among the instances owned by this instance. This method evaluates IContextOption.PlModelAccessMode. Returns a collection of instances of the specified tag among the instances owned by this instance. Returns an empty collection if no matching instances exist. |
| FindOwnerByClass(IClass) | Retrieves the first owning instance of the specified class that holds this instance. Traces the instances that own this instance in the parent direction and returns the first instance of the specified class found. Returns null if no matching instance is found even after searching up to the top-level parent element. |
| FindOwnerByClass(IPackage,string,bool) | Retrieves the first owning instance of the specified class that holds this instance. The specified class is identified under the package specified in the scope. Trace the instances that own this instance in the parent direction and return the first instance of the specified class found. If no matching instance is found even after searching up to the top-level parent element, it returns null. Note that if the class specified in the class name is not found, it returns null. Also, when performing a fuzzy match, if there are multiple matching classes, it returns the instance of the first class found. |
| FindOwnerByClass(string,bool) | Retrieves the first owning instance of the specified class that holds this instance. Trace the instances that own this instance in the parent direction and return the first instance of the specified class found. If no matching instance is found even after searching up to the top-level parent element, it returns null. Note that if the class specified in the class name is not found, it returns null. Also, when performing a fuzzy match, if there are multiple matching classes, it returns the instance of the first class found. |
| FindRelatableModels | Retrieves models that can be associated with this model using the specified reference field. If the base model for the search range is not specified, it searches the entire project. If a base model for the search range is specified, it searches for models that can be associated from the models below that model element. In this case, the retrieved models do not include associations. For fields that reference associations, call without specifying a base model for the search range. Note that if the specified field is not a reference field, it returns an empty collection. |
| GetAllChildren | Retrieves all owned instances that can be explored using a depth-first ownership search from this instance. This method evaluates IContextOption.PlModelAccessMode. Returns a collection of all owned instances that can be explored using a depth-first ownership search starting from this instance. Returns an empty collection if no matching instances exist. |
| GetAllErrorsWithChildren | Retrieves all error information, including elements below the child elements owned by this model. Returns an empty collection if no error information exists. Error information includes summary information. |
| GetAssignedFeatures | Retrieves all features assigned to this model. |
| GetChangeableMetaclasses | Retrieves all classes that can convert this model. Returns an empty collection if no convertible classes exist. Returns the class of the model that the parent model can maintain. If this model is an association, it returns the association class that the association-end model can maintain. |
| GetChildren | Retrieves the owned instances that have a direct ownership relationship with this instance. This method evaluates IContextOption.PlModelAccessMode. Returns a collection of owned instances that have a direct ownership relationship with this instance. Returns an empty collection if no such instances exist. |
| GetDerivedFromRelationsOf | Retrieves all derived associations if this model was derived from the specified model. For example, if this model is an element derived from{element A}, you can obtain its derivation association by specifying{element A} as an argument. This can be used for the following processes: ・When there is a derivation relationship between the request object and the specification object, obtain the association from the specification object to the request object. This method evaluates IContextOption.PlModelAccessMode. If no matching association exists, it returns an empty collection. |
| GetDerivedModels(IPackage,string,bool) | Gets instances derived from this instance by the specified association class. The specified class is identified from under the package specified in the scope. This method evaluates IContextOption.PlModelAccessMode. If any of the following cases apply, this method returns an empty collection. - No derived instance associated with the corresponding derived association exists. - The specified association class cannot be found. - The specified association class is not a derived association. - No reference field to the derived target by the specified derived association class can be found. |
| GetDerivedModels(IRelationshipClass) | Retrieves instances derived from this instance by the specified association class. This method evaluates IContextOption.PlModelAccessMode. |
| GetDerivedModels(string,bool) | Retrieves instances derived from this instance by the specified association class. If the association class is not specified (null), all derived instances are retrieved. This method evaluates IContextOption.PlModelAccessMode. This method returns an empty collection in the following cases: - No derived instance associated with the corresponding derived relationship exists - The specified relationship class cannot be found - The specified relationship class is not a derived relationship - A reference field to the derived target by the specified derived relationship class cannot be found |
| GetDerivedToRelationsOf | Retrieves all derived relationships of the specified model if the specified model is an element derived from this model. For example, if there is an element B derived from this model, you can retrieve its derived relationships by specifying element B as an argument. This can be used for the following processes: - When there is a derived relationship between a request object and a specification object, retrieve the relationship from the request object to the specification object This method evaluates IContextOption.PlModelAccessMode. If no matching associations exist, it returns an empty collection. |
| GetDeriveRelationsOf | Retrieves all derived associations with the specified model. This method evaluates IContextOption.PlModelAccessMode. If no matching associations exist, it returns an empty collection. Note that this method does not evaluate the direction of derivation. |
| GetDerivingModels(IPackage,string,bool) | Retrieves the source instance from which this instance is derived by the specified association class. The specified class is identified from under the package specified in the scope. This method evaluates IContextOption.PlModelAccessMode. This method returns an empty collection in the following cases: - No derived instance associated with the corresponding derived association exists. - The specified association class cannot be found. - The specified association class is not a derived association. - No reference field to the source by the specified derived association class can be found. |
| GetDerivingModels(IRelationshipClass) | Retrieves the derived instance of this instance by the specified association class. This method evaluates IContextOption.PlModelAccessMode. |
| GetDerivingModels(string,bool) | Retrieves the derived instance of this instance by the specified association class. If the association class is not specified (null), all derived instance is retrieved. This method evaluates IContextOption.PlModelAccessMode. This method returns an empty collection in the following cases: - There is no derived instance associated with the corresponding derived association - The specified association class cannot be found - The specified association class is not a derived association - A reference field to the derived source by the specified derived association class cannot be found |
| GetEditor | Retrieves the editor with the specified name corresponding to this instance. This method evaluates IContextOption.EditorAccessMode. If no corresponding editor is found, it returns null. Depending on the EditorAccessMode setting, the latest model changes may not be synchronized. Therefore, note that correct information may not be obtained for editors that have not been displayed since the model was changed. |
| GetEditors | Retrieves all editors corresponding to this instance. This method evaluates IContextOption.EditorAccessMode. If no corresponding editor exists, it returns an empty collection. Depending on the EditorAccessMode setting, the latest model changes may not be synchronized. Therefore, note that correct information may not be obtained in editors that have not been displayed since the model was changed. |
| GetField | Retrieves the value of the specified field in this instance. If the multiplicity of the specified field is 2 or more, it retrieves the first element of that field. |
| GetFieldAt | Retrieves the value at the specified index position of the specified field in this instance. |
| GetFieldString | Retrieves the value of the specified field in this instance in string format. If the specified field is of class type, it retrieves the instance name of the first element of that field. Note that if the multiplicity is 2 or more, it retrieves the first element of that field. |
| GetFieldStringAt | Retrieves the value at the specified index position of the specified field in this instance in string format. If the field at the specified index position is of a class type, it retrieves the instance name of the first element of that field. |
| GetFieldValues | Retrieves the value collection of the specified field. This method evaluates IContextOption.PlModelAccessMode. If no corresponding field value exists, it returns an empty collection. Note that the data type of the field specified in this method must be of a class type. |
| GetFieldValuesByFieldTag | Retrieves an enumeration of the values of fields with the specified tag. If there are multiple fields with the same tag, it returns a concatenated enumeration of the values of all those fields. This method does not evaluate IContextOption.PlModelAccessMode. Note that elements that are disabled in the product will also be returned. If the corresponding field value does not exist, an empty collection is returned. Note that the data type of the field to which this method assigns tags is arbitrary. Therefore, the enumeration returned by this method will be of type object. When using it, you need to convert it to the most appropriate data type. |
| GetOwnerField | Retrieves the field in the owner model of this model that holds this model. Returns null if this model is an association or if the owner model does not exist. |
| GetOwnerRelationship | Retrieves the association of this model with the owner model. Returns null if this model is an association or if the owner model does not exist. |
| GetOwners | Retrieves all owner instances that can be searched for in terms of ownership relationships for this instance. Returns a collection of instances in the parent direction of the instance that owns this instance. Returns an empty collection if no parent element exists. |
| GetProductApplyCondition | Retrieves the product apply condition expression for this model. A product apply condition expression is a logical expression that treats the "feature name variable" as a boolean variable. In the configuration, if a feature is selected, the corresponding "feature name variable" is evaluated as true. The "feature name variable" is written in the format of enclosing the feature name or feature unique name in [" and "]". Product apply condition expressions can also use the following logical operators and "(", "")" to specify the order of calculation. - AND: Logical conjunction - OR: Logical disjunction - NOT: Negation Example: • The following product application condition expression evaluates to true if the feature name is "Following driving" or "Forward Camera" selected in the configuration. [Following driving] OR [Forward Camera] • The following product application condition expression evaluates to true if the feature name is not "Constant speed driving" AND "Millimeter-wave radar" selected in the configuration. NOT [Constant speed driving] AND [Millimeter-wave radar] |
| GetReferenceFieldsOf | Retrieves the reference fields of the class of this instance that are of a type capable of storing the specified model. The fields obtained with this method will be the same as those obtained with Model.Metaclass.GetReferenceFieldOf(model.Metaclass). Furthermore, field constraints such as multiplicity and path constraints are not evaluated. |
| GetRefRelatedModels(IPackage,string,bool) | Retrieves instances that have a reference relationship with this instance by the specified related class. The specified class is identified from under the package specified in the scope. This method evaluates IContextOption.PlModelAccessMode. This method returns an empty collection in the following cases: - No instances associated with the corresponding reference relationship exist. - The specified related class cannot be found. - The reference field by the specified related class cannot be found. Note that if the specified related class is a self-referential relationship, both the source and destination relationships are evaluated. |
| GetRefRelatedModels(IRelationshipClass) | Retrieves instances that have a reference relationship with this instance through the specified related class. This method evaluates IContextOption.PlModelAccessMode. Note that if the specified related class is a self-referential relationship, both the source and target relationships are evaluated. |
| GetRefRelatedModels(string,bool) | Retrieves instances that have a reference relationship with this instance through the specified related class. If the related class is not specified (null), it retrieves all instances with reference relationships. This method evaluates IContextOption.PlModelAccessMode. This method returns an empty collection in the following cases: - No instance associated with the corresponding reference relationship exists. - The specified association class cannot be found. - The reference field by the specified association class cannot be found. Note that if the specified association class is a self-referential association, both the source and target relationships are evaluated. |
| GetRelatableFieldsOf | Retrieves the reference fields that can associate this instance with the specified model. The fields obtained with this method are evaluated for field constraints. Therefore, fields that do not satisfy the following constraints are excluded. [Constraints to evaluate] - Path constraint - Multiplicity limit |
| GetRelatingFieldsOf | Retrieves all fields of this instance's class that store the specified model as a field value. The fields obtained with this method are retrieved regardless of ownership/reference. |
| GetRelation | Retrieves the association of the specified field. This method evaluates IContextOption.PlModelAccessMode. If the specified field does not have a valid association, it returns null. If the multiplicity of the specified field is 2 or more, it retrieves the association to the first element of that field. |
| GetRelationAt | Retrieves the association of the specified position of the specified field. This method evaluates IContextOption.PlModelAccessMode. |
| GetRelations | Retrieves the association collection of the specified field. This method evaluates IContextOption.PlModelAccessMode. If no matching association exists, it returns an empty collection. |
| GetRelationsByClassTag | Retrieves instances of the related class that have been tagged with the specified tag from all fields of this instance. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. |
| GetRelationsByClassTagOf | Retrieves the relationships with the specified model that are associated with the related class that has been tagged with the specified tag from all fields of this model. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. |
| GetRelationsByFieldOf | Retrieves the relationship with the specified model in the specified field. This method evaluates IContextOption.PlModelAccessMode. If no matching associations exist, it returns an empty collection. |
| GetRelationsByFieldTag | Retrieves associations for fields with the specified tag. This method evaluates IContextOption.PlModelAccessMode. If no matching associations exist, it returns an empty collection. |
| GetRelationsByFieldTagOf | Retrieves associations for fields with the specified tag to the specified model. This method evaluates IContextOption.PlModelAccessMode. If no matching associations exist, it returns an empty collection. |
| GetRelationsByTag | Retrieves associations for fields with the specified tag. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. |
| GetRelationsOf | Retrieves all relationships with the specified model. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. Note that this method retrieves all relationships, regardless of whether they are ownership or reference relationships. |
| GetRelationsOfWhere | Retrieves relationships with the specified model that match the specified conditions of this instance. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. The relationships to retrieve can be arbitrarily determined by the evaluation function. |
| GetRelationsWhere | Retrieves all relationships that match the specified conditions for this instance. This method evaluates IContextOption.PlModelAccessMode. If no matching relationships exist, it returns an empty collection. The relationships to be retrieved can be arbitrarily determined by the evaluation function. |
| GetRepresentationsInEditor | Retrieves all representation information corresponding to this instance within the specified editor. This method evaluates IContextOption.EditorAccessMode. If no matching elements exist, it returns an empty collection. Depending on the EditorAccessMode setting, the latest model changes may not be synchronized. Therefore, note that correct information may not be obtained in editors, etc., that have not displayed the model since it was changed. |
| GetRichTextField | Retrieves the format value of the specified rich text field. Returns null if there is no value for the specified format. |
| GetRichTextFieldCustomData | Retrieves the custom format value of the specified rich text field. Returns null if the specified format is not found. |
| GetRichTextFieldFormats | Retrieves a list of formats for which the specified rich text field has a value. The order of the list is undefined. It also returns formats for which the value is an empty string. |
| Is(IClass) | Checks if this instance is an instance of the specified class. Returns True if it is an instance of the specified class. |
| Is(IPackage,string,bool) | Checks if this instance is an instance of the specified class. The specified class is identified from under the package specified in the scope. Returns True if it is an instance of the specified class. See the IModel documentation for how to specify class names and fuzzy matching options. |
| Is(string,bool) | Checks if this instance is an instance of the specified class. Returns True if it is an instance of the specified class. See the IModel documentation for how to specify class names and fuzzy matching options. |
| IsAppliedItem | Checks if this model is valid in the current product. |
| IsAppliedItemTo | Checks if this model is valid for the specified product. |
| IsAppliedItemToByName | Checks if this model is valid for the product with the specified name. |
| IsIn(IEnumerable<IClass>) | Checks if this instance is an instance of one of the specified classes. Returns True if it is an instance of one of the specified classes. |
| IsIn(IEnumerable<string>,bool) | Checks if this instance is an instance of one of the specified classes. Returns True if it is an instance of one of the specified classes. For information on how to specify class names and fuzzy matching options, please refer to the IModel documentation. |
| IsIn(IPackage,IEnumerable<string>,bool) | Checks if this instance is an instance of one of the specified classes. The specified class is identified from under the package specified in the scope. Returns True if it is an instance of one of the specified classes. For information on how to specify class names and fuzzy matching options, please refer to the IModel documentation. |
| IsIn(IPackage,string,bool) | Checks if this instance is an instance of one of the specified classes. The specified class is identified from under the package specified in the scope. Returns True if it is an instance of one of the specified classes. For information on how to specify class names and fuzzy matching options, please refer to the IModel documentation. |
| IsIn(string,bool) | Checks if this instance is an instance of one of the specified classes. Returns True if it is an instance of one of the specified classes. See the IModel documentation for how to specify class names and fuzzy matching options. |
| IsRelatedAtFieldTo | Checks if this instance has a reference relationship with the specified model on the specified field. Returns True if there is a relationship. |
| IsRelatedTo | Checks if this instance has a reference relationship with the specified model. Returns True if there is a relationship. |
| MoveTo | Moves this instance so that it becomes a child element of the specified model. If the destination parent element and field are the same as the current parent element and field, the order of elements in the specified field will be changed. Note that no exception will be thrown even if the multiplicity limit constraint of the destination field is violated. |
| NotifyFieldChanged | Notifies of a value change in the specified field. |
| Relate | Associates the model specified at the end of the specified field in this instance and returns the added associated instance. |
| RelateAll | Associates the model specified in all reference fields that can be associated with the specified model in this instance and returns a collection of all added associated instances. If a deleted model or temporary proxy is specified as the model to be associated, the association will not be made. If no association was made, an empty collection is returned. This method excludes fields that do not satisfy the following constraints from being associated: [Constraints to evaluate] - Path constraints - Type constraints - Multiplicity limit - Operation availability |
| RelateAllDerivedFrom | This method associates all fields that can be associated with the specified model as the source of this instance, and returns a collection of all associated instances added. If a deleted model or temporary proxy is specified as the model to be associated, no association will be made. If no association was made, an empty collection is returned. This method excludes fields that do not satisfy the following constraints from being associated: [Constraints to Evaluate] - Path Constraints - Type Constraints - Multiplicity Limit - Operation Availability |
| RelateAllDerivedTo | This method associates the specified model with all fields of this instance that can be associated with the specified model, and returns a collection of all associated instances added. If a deleted model or temporary proxy is specified as the model to be associated, the association will not be made. If no association was made, an empty collection is returned. This method excludes fields that do not satisfy the following constraints from being associated. [Constraints to Evaluate] - Path Constraints - Type Constraints - Multiplicity Limit - Operation Availability |
| RelateAt | This method associates the specified model with the specified field in this instance, specifying the addition location, and returns the added associated instance. |
| RelateByClassTag | This method associates the specified model with the reference field that can be associated by the associated class with the specified tag in this instance, and returns a collection of all added associated instances. If a deleted model or temporary proxy is specified for the model to be associated, the association will not be made. If no association was made, an empty collection is returned. This method excludes fields that do not satisfy the following constraints from being associated. [Constraints to Evaluate] - Path constraints - Type constraints - Multiplicity limit - Operation feasibility |
| RelateByFieldTag | This method associates the specified model with the specified tag in the reference field of this instance and returns a collection of all associated instances added. If a deleted model or temporary proxy is specified for the model to be associated, the association will not be made. If no association was made, an empty collection is returned. This method excludes fields that do not satisfy the following constraints from being associated. [Constraints to Evaluate] - Path Constraints - Type Constraints - Multiplicity Limit - Operation Availability |
| RelateWhere | This instance associates the specified model with all reference fields that match the specified conditions and returns a collection of all added related instances. If a deleted model or temporary proxy is specified as the model to be associated, the association will not be made. If no association is made, an empty collection is returned. The reference fields to be associated can be arbitrarily determined by the evaluation function. However, even if a field matches the evaluation function, if it falls under any of the following conditions, the association will not be made and the process will terminate normally. • If the field violates a path constraint • If the field type is incompatible with the given model • If the field's multiplicity is exceeded • If the field that meets the conditions is one of the following non-operable fields - Product line feature assignment fields - Fields with the System.Core tag |
| ReleaseAllAssignedFeatures | Releases all assigned features from this model. If this call removes the assignment from a feature, the product application condition expression is also removed. |
| ReleaseAssignedFeature | Releases the specified feature from this model. |
| ReleaseAssignedFeatureByName | Removes the feature with the specified name from this model. |
| ReleaseAssignedFeatures | Removes all of the specified features from this model. |
| ReleaseAssignedFeaturesByName | Removes all of the features with the specified name from this model. |
| RemoveError | Removes any error information added to this model. If you specify null for the error information to be removed, or if the error information is not included in this model, nothing will happen and the process will terminate normally. |
| RemoveField | Deletes the value of the specified field in this instance. If the specified field is an owned field, the specified model is deleted. If the specified field is a referenced field, only the reference association is deleted, and the model is preserved. Note that if the model to be deleted is not included in the specified field, nothing is done and the process terminates normally. |
| RemoveFieldAt | Deletes the field value at the specified position in this instance. If the specified field is an owned field, the model at the specified position is deleted. If the specified field is a referenced field, only the reference association at the specified position is deleted, and the model is preserved. |
| SetField | Sets the specified value to the specified field in this instance. If a value that cannot be set to the specified field is specified, an exception is thrown. Note that if the multiplicity of the specified field is 2 or more, the first element of the field is set. |
| SetFieldAt | Sets the specified value to the specified index position of the specified field in this instance. An exception is thrown if a value that cannot be set to the specified field is specified. However, no exception is thrown if the field's multiplicity limit constraint or path constraint is violated. |
| SetInitField | Sets the initial value of the field defined in the metamodel to the specified field in this instance. If an initial value for the field is not specified in the metamodel, the default value of the field type is set. If this method is called on an owned field of a class type, the IModel that was set as the field value is deleted. Also, if this method is called on a referenced field of a class type, the association with the IModel that was set as the field value is deleted (the IModel of the field value is not deleted and is maintained). |
| SetProductApplyCondition | Sets the product application condition expression for this model. Note that if a feature name that is not assigned to this model is used in the product application condition expression, the feature will be automatically assigned. Also, if a feature name that is already assigned to this model is not used in the condition expression, the assignment to the feature will be automatically removed. If an empty string is specified in the condition expression, all feature assignments will be removed. |
| SetRichTextField(string,string,string,string) | Sets the value to the format of the specified rich text field. The textValue specification is ignored, and the value for the "text" format is automatically generated and set at the same time. |
| SetRichTextField(string,string,string) | Sets the value to the format of the specified rich text field. If you specify the "html" format, the value for the "text" format will also be automatically generated and set at the same time. |
| SetRichTextField(string,string) | [Obsolete] Does nothing. |
| SetRichTextFieldCustomData | Sets a value for the custom format of the specified rich text field. The value for the custom format is not displayed on the UI. It can only be obtained and set via the API. |
| SetRichTextFieldValues | Sets an Html value for the specified rich text field. The textValue specification is ignored, and the value for the "text" format is also automatically generated from the htmlValue value and set at the same time. |
| Take | Moves the specified model to the specified field of this instance. The parent element of the model to be moved becomes this instance. Note that no exception is thrown even if the multiplicity limit constraint of the destination field is violated. |
| UnRelate | This instance removes the reference association between the specified field and the specified model. If there are multiple associations for the field, all of them are removed. If no association exists with the specified model, nothing happens and the process terminates normally. |
| UnRelateAll | This instance removes all reference associations with the specified model. If no association exists with the specified model, nothing happens and the process terminates normally. Furthermore, associations to fields that meet the following conditions are not removed and the process terminates normally: ・Associations in product line support fields ・Associations in fields with the System.Core tag |
| UnRelateAllDerivedFrom | This instance removes all associations derived from the specified model. If no association exists with the specified model, nothing will happen and the process will terminate normally. Also, associations to fields that meet the following conditions will not be removed and the process will terminate normally: ・Associations in product line support fields ・Associations in fields with the System.Core tag |
| UnRelateAllDerivedTo | Removes all associations derived from this instance to the specified model. If no association exists with the specified model, nothing will happen and the process will terminate normally. Also, associations to fields that meet the following conditions will not be removed and the process will terminate normally: ・Associations in product line support fields ・Associations in fields with the System.Core tag |
| UnRelateByClassTag | Removes the association from the specified model to reference fields that can be associated by the association class with the specified tag of this instance. If no association exists with the specified model, nothing will happen and the process will terminate normally. Also, associations to fields that meet the following conditions will not be removed and the process will terminate normally: ・Associations in product line support fields ・Associations in fields with the System.Core tag |
| UnRelateByFieldTag | Removes the association between the specified model and the reference field with the specified tag of this instance. If no association exists with the specified model, nothing will happen and the process will terminate normally. Also, associations to fields that meet the following conditions will not be removed and the process will terminate normally: ・Associations in product line support fields ・Associations in fields with the System.Core tag |
| UnRelateWhere | Removes all reference associations between this instance and the specified model that match the specified conditions. The target for unlinking can be arbitrarily determined by the evaluation function. However, the following associations will not be unlinked and the process will terminate normally. ・If the association that matches the condition is an association for product line support ・If the System.Core tag is attached to the field at the end of the association that matches the condition |
| Validate | Validates this model. Recursively validates this model and all elements under its child elements. This method clears all previous error information at runtime. [When this method is executed on a project (IProject)] ・If there are unloaded model files in the project, error information to that effect is added to the model that serves as the base for the design model (the model displayed at the root of the model navigator). This is to inform the caller that validation has not been performed for all models in the project because there are unloaded model files. ・This includes models that cannot be reached due to the project's ownership relationships because there are unloaded model files in the project (models whose parents are unloaded). [Validation Content] ・Standard validation as defined by the application ・Validation extended by the extension's validation event |
| Validate(ValidationOptions) | Validates this model. Depending on the option specified, this model only will be validated, or this model and all elements under its child elements will be recursively validated. This method clears all previous error information at runtime. [When this method is executed on a project (IProject)] ・If there are unloaded model files in the project, error information to that effect will be added to the model that serves as the base for the design model (the model displayed at the root of the model navigator). This is to inform the caller that validation has not been performed for all models in the project because there are unloaded model files. ・Includes models that cannot be reached due to project ownership relationships because there are unloaded model files in the project (models whose parent is unloaded). [Verification Content] ・Standard verification as defined by the application enabled in the options ・If the issuance of model verification events is specified in the options, extended verification by the extension's verification events |
Extension Methods
| Name | Description |
|---|---|
| IsDesignModel | Checks if this model is the design model root (the root model in the Model Navigator). |
| IsProductLineElement | Checks if this model is a product line element. |
| IsReadonly | Checks if this model is read-only. Returns False if a model unit corresponding to this model cannot be retrieved. |
Related Topics
| Name | Description |
|---|---|
| Editing Models | Edits various NextDesign model information via the API. |