AttributeDef: Difference between revisions
Appearance
No edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
The describe method, inherited from Contained, returns an AttributeDescription structure in the "value" member of the Description structure (defined in the Contained class). | The describe method, inherited from Contained, returns an AttributeDescription structure in the "value" member of the Description structure (defined in the Contained class). | ||
; File stem: attribdf | ;File stem: attribdf | ||
; Base : Contained | ;Base : Contained | ||
; Metaclass : SOMClass | ;Metaclass : SOMClass | ||
; Ancestor Classes : Contained : SOMOBject | ;Ancestor Classes : Contained : SOMOBject | ||
==Types== | ==Types== | ||
enum AttributeMode {NORMAL, READONLY}; | enum AttributeMode {NORMAL, READONLY}; | ||
Line 17: | Line 16: | ||
AttributeMode mode; | AttributeMode mode; | ||
}; | }; | ||
==Attributes== | ==Attributes== | ||
Listed below is each available attribute, with its corresponding type in parentheses, followed by a description of its purpose: | Listed below is each available attribute, with its corresponding type in parentheses, followed by a description of its purpose: | ||
;type (TypeCode) : The TypeCode that represents the type of the attribute. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving AttributeDef object, which retains ownership. Hence, the returned TypeCode should not be freed. To obtain a separate copy, use the TypeCode_copy operation. The "_set_" form of the attribute makes a private copy of the TypeCode you supply, to keep in the receiving object. You retain ownership of the passed TypeCode. | |||
; type (TypeCode) : The TypeCode that represents the type of the attribute. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving AttributeDef object, which retains ownership. Hence, the returned TypeCode should not be freed. To obtain a separate copy, use the TypeCode_copy operation. The "_set_" form of the attribute makes a private copy of the TypeCode you supply, to keep in the receiving object. You retain ownership of the passed TypeCode. mode (AttributeMode) | ;mode (AttributeMode):The AttributeMode of the attribute (NORMAL or READONLY). | ||
The AttributeMode of the attribute (NORMAL or READONLY). | |||
==New methods== | ==New methods== | ||
There are currently no new methods defined for the AttributeDef class. | There are currently no new methods defined for the AttributeDef class. | ||
==Overridden methods== | ==Overridden methods== | ||
The following list shows all the methods overridden by the AttributeDef 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 AttributeDef class. These methods are overridden in order to modify the behavior defined by an ancestor class. | ||
* [[somInit]] | * [[somInit]] | ||
* [[somUninit]] | * [[somUninit]] | ||
* [[somDumpSelf]] | * [[somDumpSelf]] | ||
* [[somDumpSelfInt]] | * [[somDumpSelfInt]] | ||
[[Category:SOM IRF]] | [[Category:SOM IRF]] |
Latest revision as of 22:05, 7 November 2021
The describe method, inherited from Contained, returns an AttributeDescription structure in the "value" member of the Description structure (defined in the Contained class).
- File stem
- attribdf
- Base
- Contained
- Metaclass
- SOMClass
- Ancestor Classes
- Contained : SOMOBject
Types
enum AttributeMode {NORMAL, READONLY}; struct AttributeDescription { Identifier name; RepositoryId id; RepositoryId defined_in; TypeCode type; AttributeMode mode; };
Attributes
Listed below is each available attribute, with its corresponding type in parentheses, followed by a description of its purpose:
- type (TypeCode)
- The TypeCode that represents the type of the attribute. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving AttributeDef object, which retains ownership. Hence, the returned TypeCode should not be freed. To obtain a separate copy, use the TypeCode_copy operation. The "_set_" form of the attribute makes a private copy of the TypeCode you supply, to keep in the receiving object. You retain ownership of the passed TypeCode.
- mode (AttributeMode)
- The AttributeMode of the attribute (NORMAL or READONLY).
New methods
There are currently no new methods defined for the AttributeDef class.
Overridden methods
The following list shows all the methods overridden by the AttributeDef class. These methods are overridden in order to modify the behavior defined by an ancestor class.