NAME

CORBA::Object::get_component - (operation) return the component associated with an object


SYNOPSIS

IDL

  module CORBA
    {
      {
      Object get_component ( ) ;
      } ;
    } ;

C

  #include <orb.h>
  CORBA_Object CORBA_Object_get_component
      ( CORBA_Object o, CORBA_Environment * ev ) ;

C++

  #include <orb.h>
  namespace CORBA
    {
    class Object
      {
        public:
          Object_ptr _get_component ( ) ;
      } ;
    } ;

Java

  package org.omg.CORBA ;
  public interface Object
    {
      org.omg.CORBA.Object _get_component ( ) ;
    }

Perl

(TBS)

Lisp

(TBS)


DESCRIPTION

The CORBA::Object::get_component operation returns the component associated with an object. If the target object is, itself, a component, then the operation returns the same reference, or another equivalent reference to the same object. If the target object is a facet, then the operation returns an object reference for the component. Otherwise, there is no component associated with the object, and the operation returns the nil object.


PARAMETERS

o

(C mapping only) the target object

ev

(C mapping only) a pointer to the CORBA_Environment


RETURN VALUE

The component object associated with the target reference, if there is such a component, else the nil object.


EXCEPTIONS

(standard system exceptions)


NOTES

  1. (C++ mapping only) The IDL header is named orb.idl. The C++ mapping specification does not mention a specific header name. One might presume the header name should be orb.h. However, some ORB vendors are more imaginative, and use other, different header file names.

  2. (C++ mapping only) The C++ mapping of names may vary, depending on the implementation's support for nested classes and namespaces. The rules are:

        if C++ namespace is supported,
            then map IDL module to C++ namespace
        else if C++ nested classes are supported,
            then map IDL module to a C++ class
        else
            use the C mapping for names

    The C++ synopsis, above, assumes namespace support. For other situations, adjust accordingly.


SEE ALSO

CORBA::Object(3corba)


COPYRIGHT

Copyright 2012 Michael Marking. This document is distributed as part of corbadoc, a documentation-only package with the goal of describing the main CORBA-related definitions from the OMG specifications. This is version corbadoc-0.1.3-prototype, released 2011.12.23. corbadoc is an incomplete work in progress; this is a snapshot release. New releases will be posted at http://www.tatanka.com/software/corbadoc/.

The corbadoc documents, including this one, are licensed under the GNU Free Documentation License, v.1.3.