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