TAO  2.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
TAO_Target_Specification Class Reference

A class to encapsulate all the ways of specifying targets. More...

#include <target_specification.h>

Collaboration diagram for TAO_Target_Specification:
Collaboration graph

Public Types

enum  TAO_Target_Address { Key_Addr = 0, Profile_Addr, Reference_Addr }
 

Public Member Functions

 TAO_Target_Specification (void)
 Ctor. More...
 
void target_specifier (const TAO::ObjectKey &key)
 
void target_specifier (IOP::TaggedProfile &profile)
 Set the target specification by passing in an IOP::TaggedProfile. More...
 
void target_specifier (IOP::IOR &ior, CORBA::ULong prof_index)
 
const TAO::ObjectKeyobject_key (void)
 
const IOP::TaggedProfile * profile (void)
 
CORBA::ULong iop_ior (IOP::IOR *&ior)
 
TAO_Target_Address specifier (void)
 Access the TArget_Address specifier. More...
 

Private Attributes

union {
   TAO::ObjectKey *   object_key_
 
   IOP::TaggedProfile *   profile_
 
   IOP::IOR *   ior_
 
u_
 
TAO_Target_Address specifier_
 The enum identifier. More...
 
CORBA::ULong profile_index_
 The profile index. More...
 

Detailed Description

A class to encapsulate all the ways of specifying targets.

Member Enumeration Documentation

Enumerator
Key_Addr 
Profile_Addr 
Reference_Addr 

Constructor & Destructor Documentation

TAO_Target_Specification::TAO_Target_Specification ( void  )

Ctor.

Member Function Documentation

CORBA::ULong TAO_Target_Specification::iop_ior ( IOP::IOR *&  ior)

Returns a pointer to IOP::IOR through the parameters and the index of the selected profile as a return parameter after a check of the stored specifier. If the stored specifier is not of the right type then this would return a NULL.

const TAO::ObjectKey * TAO_Target_Specification::object_key ( void  )

Returns the object key after a check of the stored specifier. If the stored specifier is not of the right type then this would return a NULL

const IOP::TaggedProfile * TAO_Target_Specification::profile ( void  )

Returns the IOP::TaggedProfile after a check of the stored specifier. If the stored specifier is not of the right type then this would return a NULL

TAO_Target_Specification::TAO_Target_Address TAO_Target_Specification::specifier ( void  )

Access the TArget_Address specifier.

void TAO_Target_Specification::target_specifier ( const TAO::ObjectKey key)

Set the target specification by giving the object key.

Note
Please do not pass in a identifiers that is allocated on stack. These methods does not make a copy but holds the pointer passed in.
void TAO_Target_Specification::target_specifier ( IOP::TaggedProfile &  profile)

Set the target specification by passing in an IOP::TaggedProfile.

void TAO_Target_Specification::target_specifier ( IOP::IOR &  ior,
CORBA::ULong  prof_index 
)

Specify the target by passing in the IOP::IOR with a profile index. Please see the header file IOPC.h on why a profile index is required.

Member Data Documentation

IOP::IOR* TAO_Target_Specification::ior_
TAO::ObjectKey* TAO_Target_Specification::object_key_
IOP::TaggedProfile* TAO_Target_Specification::profile_
CORBA::ULong TAO_Target_Specification::profile_index_
private

The profile index.

TAO_Target_Address TAO_Target_Specification::specifier_
private

The enum identifier.

union { ... } TAO_Target_Specification::u_

The documentation for this class was generated from the following files: