TAO_Target_Specification Class Reference

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

#include <target_specification.h>

List of all members.

Public Types

enum  TAO_Target_Address { Key_Addr = 0, Profile_Addr, Reference_Addr }

Public Member Functions

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

Private Attributes

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


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 ( 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.

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 ( 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.


Member Data Documentation

The profile index.

The enum identifier.

union { ... } TAO_Target_Specification::u_ [private]

The union of all the possibilities.


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

Generated on Mon Jul 13 16:27:11 2009 for TAO by  doxygen 1.5.8