Contained: Difference between revisions
Created page with "File stem: containd ;Base :SOMObject ;Metaclass :SOMClass ;Ancestor Classes SOMObject Description Types typedef string RepositoryId; struct ..." |
No edit summary |
||
Line 1: | Line 1: | ||
File stem: containd | ;File stem | ||
: containd | |||
;Base | ;Base | ||
Line 10: | Line 11: | ||
SOMObject | SOMObject | ||
==Types== | |||
Types | |||
typedef string RepositoryId; | typedef string RepositoryId; | ||
Line 21: | Line 20: | ||
==Attributes == | |||
All attributes of the Contained class provide access to information kept within the receiving object. The "_get_" form of the attribute returns a memory reference that is only valid as long as the receiving object has not been freed (using _somFree). The "_set_" form of the attribute makes a (deep) copy of your data and places it in the receiving object. You retain ownership of all memory references passed using the "_set_" attributes. | All attributes of the Contained class provide access to information kept within the receiving object. The "_get_" form of the attribute returns a memory reference that is only valid as long as the receiving object has not been freed (using _somFree). The "_set_" form of the attribute makes a (deep) copy of your data and places it in the receiving object. You retain ownership of all memory references passed using the "_set_" attributes. | ||
Line 28: | Line 27: | ||
;name (Identifier) | ;name (Identifier) | ||
A simple name that identifies the Contained object within its containment hierarchy. The name may not be unique outside of the containment hierarchy; thus it may require qualification by ModuleDef name and/or InterfaceDef name. | :A simple name that identifies the Contained object within its containment hierarchy. The name may not be unique outside of the containment hierarchy; thus it may require qualification by ModuleDef name and/or InterfaceDef name. | ||
;id (RepositoryId) | ;id (RepositoryId) | ||
The value of the "id" field of the Contained object. This is a string that uniquely identifies any object in the IR; thus it needs no qualification. Note that RepositoryIds have no relationship to the SOM type somId. | :The value of the "id" field of the Contained object. This is a string that uniquely identifies any object in the IR; thus it needs no qualification. Note that RepositoryIds have no relationship to the SOM type somId. | ||
;defined_in (RepositoryId) | ;defined_in (RepositoryId) | ||
The value of the "defined_in" field of the Contained object. This ID uniquely identifies the container where the Contained object is defined. Objects without global scope that do not appear within any other object are, by default, placed in the Repository object. | :The value of the "defined_in" field of the Contained object. This ID uniquely identifies the container where the Contained object is defined. Objects without global scope that do not appear within any other object are, by default, placed in the Repository object. | ||
;somModifiers (sequence <somModifier>) | ;somModifiers (sequence <somModifier>) | ||
The somModifiers attribute is a sequence containing all modifiers associated with the object in the "implementation" section of the SOM IDL file where the receiving object is defined. | :The somModifiers attribute is a sequence containing all modifiers associated with the object in the "implementation" section of the SOM IDL file where the receiving object is defined. | ||
Note: This attribute is a SOM-unique extension of the Interface Repository; it is not stipulated by the CORBA specification. | Note: This attribute is a SOM-unique extension of the Interface Repository; it is not stipulated by the CORBA specification. | ||
==New methods == | |||
The following list shows all the Contained methods. | The following list shows all the Contained methods. | ||
Line 48: | Line 47: | ||
*describe | *describe | ||
==Overridden methods== | |||
The following list shows all the methods overridden by the Contained class. These methods are overridden in order to modify the behavior defined by an ancestor class. | The following list shows all the methods overridden by the Contained class. These methods are overridden in order to modify the behavior defined by an ancestor class. |
Revision as of 03:01, 29 November 2020
- File stem
- containd
- Base
- SOMObject
- Metaclass
- SOMClass
- Ancestor Classes
SOMObject
Types
typedef string RepositoryId; struct Description { Identifier name; any value; };
Attributes
All attributes of the Contained class provide access to information kept within the receiving object. The "_get_" form of the attribute returns a memory reference that is only valid as long as the receiving object has not been freed (using _somFree). The "_set_" form of the attribute makes a (deep) copy of your data and places it in the receiving object. You retain ownership of all memory references passed using the "_set_" attributes.
Listed below is each available attribute, with its corresponding type in parentheses, followed by a description of its purpose:
- name (Identifier)
- A simple name that identifies the Contained object within its containment hierarchy. The name may not be unique outside of the containment hierarchy; thus it may require qualification by ModuleDef name and/or InterfaceDef name.
- id (RepositoryId)
- The value of the "id" field of the Contained object. This is a string that uniquely identifies any object in the IR; thus it needs no qualification. Note that RepositoryIds have no relationship to the SOM type somId.
- defined_in (RepositoryId)
- The value of the "defined_in" field of the Contained object. This ID uniquely identifies the container where the Contained object is defined. Objects without global scope that do not appear within any other object are, by default, placed in the Repository object.
- somModifiers (sequence <somModifier>)
- The somModifiers attribute is a sequence containing all modifiers associated with the object in the "implementation" section of the SOM IDL file where the receiving object is defined.
Note: This attribute is a SOM-unique extension of the Interface Repository; it is not stipulated by the CORBA specification.
New methods
The following list shows all the Contained methods.
- within
- describe
Overridden methods
The following list shows all the methods overridden by the Contained class. These methods are overridden in order to modify the behavior defined by an ancestor class.
- somFree
- somInit
- somUninit
- somDumpSelf
- somDumpSelfInt