Overview | The describe operation returns a structure containing information about a CORBA::AttributeDef Interface Repository object. |
Original interface | CORBA module: AttributeDef Interface |
Exceptions | CORBA::SystemException |
Intended Usage
The inherited describe operation returns a structure (CORBA::Contained::Description) that contains information about a CORBA::AttributeDef Interface Repository object. The CORBA::Contained::Description structure has two fields: kind (CORBA::DefinitionKind data type), and value (CORBA::Any data type).
The kind of definition described by the returned structure is provided using the kind field, and the value field is a CORBA::Any that contains the description that is specific to the kind of object described. When the describe operation is invoked on an attribute (CORBA::AttributeDef) object, the kind field is equal to CORBA::dk_Attribute and the value field contains the CORBA::AttributeDescription structure.
Syntax
struct AttributeDescription { Identifier name; RepositoryId id; RepositoryId defined_in; VersionSpec version; TypeCode type; AttributeMode mode; }; struct Description { DefinitionKind kind; any value; }; Description describe ();
Input parameters
None.
Return values
Example
// C++ // assume that 'this_attribute' has already been initialized CORBA::AttributeDef * this_attribute; // retrieve a description of the attribute CORBA::AttributeDef::Description * returned_description; returned_description = this_attribute-> describe (); // retrieve the attribute description from the returned description // structure CORBA::AttributeDescription * attribute_description; attribute_description = (CORBA::AttributeDescription *) returned_description-> value.value ();