ParameterDef

File stem

paramdef

Base

Contained

Metaclass

SOMClass

Ancestor Classes

Contained

SOMObject

Types

 
enum  ParameterMode  { IN, OUT, INOUT };

struct ParameterDescription {
    Identifier      name;
    RepositoryId    id;
    RepositoryId    defined_in;
    TypeCode        type;
    ParameterMode   mode;
};

The describe method, inherited from Contained, returns a ParameterDescription 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 parameter. The TypeCode returned by the "_get_" form of the type attribute is contained in the receiving ParameterDef 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 (ParameterMode)

The ParameterMode of the parameter (IN, OUT, or INOUT).

New methods

There are currently no new methods defined for the ParameterDef class.

Overridden methods

The following list shows all the methods overridden by the ParameterDef class. These methods are overridden in order to modify the behavior defined by an ancestor class.

• somInit
• somUninit
• somDumpSelf
• somDumpSelfInt
• describe