ConstantDef: Difference between revisions
mNo edit summary |
|||
| Line 1: | Line 1: | ||
The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class). | The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class). | ||
; File stem: constdef | ; File stem: constdef | ||
; Base : Contained | ; Base : Contained | ||
; Metaclass : SOMClass | ; Metaclass : SOMClass | ||
; Ancestor Classes : Contained : SOMObject | ; Ancestor Classes : Contained : SOMObject | ||
==Types== | ==Types== | ||
struct ConstantDescription { | struct ConstantDescription { | ||
Identifier name; | Identifier name; | ||
| Line 15: | Line 13: | ||
any value; | any value; | ||
}; | }; | ||
The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class). | The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class). | ||
==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 constant. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving ConstantDef 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 constant. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving ConstantDef 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. value (any) | ;value (any):The value of the constant. | ||
==New methods== | ==New methods== | ||
There are currently no new methods defined for the ConstantDef class. | There are currently no new methods defined for the ConstantDef class. | ||
==Overridden methods== | ==Overridden methods== | ||
The following list shows all the methods overridden by the ConstantDef 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 ConstantDef class. These methods are overridden in order to modify the behavior defined by an ancestor class. | ||
* [[somInit]] | * [[somInit]] | ||
* [[somUninit]] | * [[somUninit]] | ||
Latest revision as of 22:07, 7 November 2021
The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class).
- File stem
- constdef
- Base
- Contained
- Metaclass
- SOMClass
- Ancestor Classes
- Contained : SOMObject
Types
struct ConstantDescription {
Identifier name;
RepositoryId id;
RepositoryId defined_in;
TypeCode type;
any value;
};
The describe method, inherited from Contained, returns a ConstantDescription structure in the "value" member of the Description structure (defined in the Contained class).
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 constant. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving ConstantDef 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.
- value (any)
- The value of the constant.
New methods
There are currently no new methods defined for the ConstantDef class.
Overridden methods
The following list shows all the methods overridden by the ConstantDef class. These methods are overridden in order to modify the behavior defined by an ancestor class.
- somInit
- somUninit
- somDumpSelf
- somDumpSelfInt
- describe