OperationDef: Difference between revisions
Appearance
Created page with ";File stem: operatdf ;Base :Contained :Container ;Metaclass :SOMClass ;Ancestor Classes :Contained ::Container :::SOMObject ==Types== <pre> typedef Identifier Conte..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
;File stem: operatdf | ;File stem: operatdf | ||
;Base | ;Base | ||
:Contained | :Contained | ||
:Container | :Container | ||
;Metaclass | ;Metaclass | ||
:SOMClass | :SOMClass | ||
;Ancestor Classes | ;Ancestor Classes | ||
:Contained | :Contained | ||
::Container | ::Container | ||
:::SOMObject | :::SOMObject | ||
==Types== | ==Types== | ||
<pre> | <pre> | ||
typedef Identifier ContextIdentifier; | typedef Identifier ContextIdentifier; | ||
enum OperationMode { NORMAL, ONEWAY }; | enum OperationMode { NORMAL, ONEWAY }; | ||
struct OperationDescription | struct OperationDescription { | ||
Identifier name; | Identifier name; | ||
RepositoryId id; | RepositoryId id; | ||
Line 24: | Line 25: | ||
sequence < ExceptionDef::ExceptionDescription> exceptions; | sequence < ExceptionDef::ExceptionDescription> exceptions; | ||
}; | }; | ||
</pre> | </pre> | ||
The describe method, inherited from Contained, returns an OperationDescription structure in the "value" member of the Description structure (defined in the Contained class). The describe_contents method, inherited from Container, returns a sequence of these Description structures, each carrying a reference to an OperationDescription structure in its "value" member. | The describe method, inherited from Contained, returns an OperationDescription structure in the "value" member of the Description structure (defined in the Contained class). The describe_contents method, inherited from Container, returns a sequence of these Description structures, each carrying a reference to an OperationDescription structure in its "value" member. | ||
==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: | ||
;result (TypeCode):The TypeCode that represents the type of the operation (method). The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving OperationDef 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 (OperationMode):The OperationMode of the operation (method), either NORMAL or ONEWAY. | |||
;contexts (sequence <ContextIdentifier>):The list of ContextIdentifiers associated with the operation (method). The "_get_" form of the attribute returns a sequence whose buffer is owned by the receiving OperationDef object. You should not free it. The "_set_" form of the attribute makes a (deep) copy of the passed sequence; you retain ownership of the original storage. | |||
==New methods== | |||
There are currently no new methods defined for the OperationDef class. | |||
==New methods== | |||
There are currently no new methods defined for the OperationDef class. | |||
==Overridden methods== | ==Overridden methods== | ||
The following list shows all the methods overridden by the OperationDef 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 OperationDef 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 02:26, 8 November 2021
- File stem
- operatdf
- Base
- Contained
- Container
- Metaclass
- SOMClass
- Ancestor Classes
- Contained
- Container
- SOMObject
- Container
Types
typedef Identifier ContextIdentifier; enum OperationMode { NORMAL, ONEWAY }; struct OperationDescription { Identifier name; RepositoryId id; RepositoryId defined_in; TypeCode result; OperationMode mode; sequence <ContextIdentifier> contexts; sequence <ParameterDef::ParameterDescription> parameter; sequence < ExceptionDef::ExceptionDescription> exceptions; };
The describe method, inherited from Contained, returns an OperationDescription structure in the "value" member of the Description structure (defined in the Contained class). The describe_contents method, inherited from Container, returns a sequence of these Description structures, each carrying a reference to an OperationDescription structure in its "value" member.
Attributes
Listed below is each available attribute, with its corresponding type in parentheses, followed by a description of its purpose:
- result (TypeCode)
- The TypeCode that represents the type of the operation (method). The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving OperationDef 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 (OperationMode)
- The OperationMode of the operation (method), either NORMAL or ONEWAY.
- contexts (sequence <ContextIdentifier>)
- The list of ContextIdentifiers associated with the operation (method). The "_get_" form of the attribute returns a sequence whose buffer is owned by the receiving OperationDef object. You should not free it. The "_set_" form of the attribute makes a (deep) copy of the passed sequence; you retain ownership of the original storage.
New methods
There are currently no new methods defined for the OperationDef class.
Overridden methods
The following list shows all the methods overridden by the OperationDef class. These methods are overridden in order to modify the behavior defined by an ancestor class.
- somInit
- somUninit
- somDumpSelf
- somDumpSelfInt
- describe