Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

TAO::Argument Class Reference

Base class for argument class templates. More...

#include <Argument.h>

Inheritance diagram for TAO::Argument:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~Argument (void)
 Destructor.

virtual CORBA::Boolean marshal (TAO_OutputCDR &cdr)
 Marshal the argument into the given CDR output stream.

virtual CORBA::Boolean demarshal (TAO_InputCDR &)
 Demarshal the argument from the given CDR input stream.

virtual Argument * clone (void)
 Template method to clone a TAO Argument.

Portable Interceptor Related Methods
These methods are only used when setting up PortableInterceptor::RequestInfo instances with the appropriate operation-specific parameter list and return value, if either or both exist.

virtual void interceptor_value (CORBA::Any *) const
 Populate the given CORBA::Any result argument.

virtual CORBA::ParameterMode mode (void) const=0
 Get the parameter mode of this argument.

Detailed Description

Base class for argument class templates.

Argument subclasses override the virtual methods appropriately. For example, a stub "IN" argument class template would override the marshal() method, but wouldn't need to override the demarshal() method.

Definition at line 52 of file Argument.h.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO::Argument::~Argument (  void   )  [virtual]
 

Destructor.

Definition at line 9 of file Argument.cpp. 

00010 {
00011 }

Member Function Documentation

TAO::Argument * TAO::Argument::clone (  void   )  [virtual]
 

Template method to clone a TAO Argument.

Reimplemented in TAO::Void_Return_Argument, TAO::In_Basic_Clonable_Argument_T< S, Insert_Policy >, TAO::In_BD_String_Clonable_Argument_T< S_var, BOUND, Insert_Policy >, TAO::In_Fixed_Array_Clonable_Argument_T< S_forany, Insert_Policy >, TAO::In_Fixed_Size_Clonable_Argument_T< S, Insert_Policy >, TAO::In_Object_Clonable_Argument_T< S_ptr, Insert_Policy >, TAO::In_Special_Basic_Clonable_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::In_UB_String_Clonable_Argument_T< S_var, Insert_Policy >, TAO::In_Var_Array_Clonable_Argument_T< S_forany, Insert_Policy >, and TAO::In_Var_Size_Clonable_Argument_T< S, Insert_Policy >.

Definition at line 26 of file Argument.cpp. 

00027 {
00028   return 0;
00029 }

CORBA::Boolean TAO::Argument::demarshal (  TAO_InputCDR &   )  [virtual]
 

Demarshal the argument from the given CDR input stream.

Note:
The default implementation simply returns true.

Reimplemented in TAO::Inout_Basic_Argument_T< S, Insert_Policy >, TAO::Out_Basic_Argument_T< S, Insert_Policy >, TAO::Ret_Basic_Argument_T< S, Insert_Policy >, TAO::Inout_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Out_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Ret_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Inout_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Out_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Ret_Fixed_Array_Argument_T< S_var, S_forany, Insert_Policy >, TAO::Inout_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Out_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Ret_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Inout_Object_Argument_T< S_ptr, S_traits, Insert_Policy >, TAO::Out_Object_Argument_T< S_ptr, S_out, Insert_Policy >, TAO::Ret_Object_Argument_T< S_ptr, S_var, Insert_Policy >, TAO::Inout_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Out_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Ret_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Inout_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Out_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Ret_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Inout_Var_Array_Argument_T< S_forany, Insert_Policy >, TAO::Out_Var_Array_Argument_T< S_out, S_forany, Insert_Policy >, TAO::Ret_Var_Array_Argument_T< S_var, S_forany, Insert_Policy >, TAO::Inout_Var_Size_Argument_T< S, Insert_Policy >, TAO::Out_Var_Size_Argument_T< S, Insert_Policy >, and TAO::Ret_Var_Size_Argument_T< S, Insert_Policy >.

Definition at line 20 of file Argument.cpp. 

00021 {
00022   return true;
00023 }

void TAO::Argument::interceptor_value (  CORBA::Any *   )  const [virtual]
 

Populate the given CORBA::Any result argument.

Note:
The default implementation is a no-op.

Reimplemented in TAO::In_Basic_Argument_T< S, Insert_Policy >, TAO::Inout_Basic_Argument_T< S, Insert_Policy >, TAO::Out_Basic_Argument_T< S, Insert_Policy >, TAO::Ret_Basic_Argument_T< S, Insert_Policy >, TAO::In_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Inout_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Out_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Ret_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::In_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Inout_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Out_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Ret_Fixed_Array_Argument_T< S_var, S_forany, Insert_Policy >, TAO::In_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Inout_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Out_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Ret_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::In_Object_Argument_T< S_ptr, Insert_Policy >, TAO::Inout_Object_Argument_T< S_ptr, S_traits, Insert_Policy >, TAO::Out_Object_Argument_T< S_ptr, S_out, Insert_Policy >, TAO::Ret_Object_Argument_T< S_ptr, S_var, Insert_Policy >, TAO::In_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Inout_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Out_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Ret_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::In_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Inout_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Out_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Ret_UB_String_Argument_T< S_var, Insert_Policy >, TAO::In_Var_Array_Argument_T< S_forany, Insert_Policy >, TAO::Inout_Var_Array_Argument_T< S_forany, Insert_Policy >, TAO::Out_Var_Array_Argument_T< S_out, S_forany, Insert_Policy >, TAO::Ret_Var_Array_Argument_T< S_var, S_forany, Insert_Policy >, TAO::In_Var_Size_Argument_T< S, Insert_Policy >, TAO::Inout_Var_Size_Argument_T< S, Insert_Policy >, TAO::Out_Var_Size_Argument_T< S, Insert_Policy >, and TAO::Ret_Var_Size_Argument_T< S, Insert_Policy >.

Definition at line 34 of file Argument.cpp. 

00035 {
00036 }

CORBA::Boolean TAO::Argument::marshal (  TAO_OutputCDR &  cdr  )  [virtual]
 

Marshal the argument into the given CDR output stream.

Note:
The default implementation simply returns true.

Reimplemented in TAO::In_Basic_Argument_T< S, Insert_Policy >, TAO::Inout_Basic_Argument_T< S, Insert_Policy >, TAO::In_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::Inout_BD_String_Argument_T< S_var, BOUND, Insert_Policy >, TAO::In_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::Inout_Fixed_Array_Argument_T< S_forany, Insert_Policy >, TAO::In_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::Inout_Fixed_Size_Argument_T< S, Insert_Policy >, TAO::In_Object_Argument_T< S_ptr, Insert_Policy >, TAO::Inout_Object_Argument_T< S_ptr, S_traits, Insert_Policy >, TAO::In_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::Inout_Special_Basic_Argument_T< S, to_S, from_S, Insert_Policy >, TAO::In_UB_String_Argument_T< S_var, Insert_Policy >, TAO::Inout_UB_String_Argument_T< S_var, Insert_Policy >, TAO::In_Var_Array_Argument_T< S_forany, Insert_Policy >, TAO::Inout_Var_Array_Argument_T< S_forany, Insert_Policy >, TAO::In_Var_Size_Argument_T< S, Insert_Policy >, and TAO::Inout_Var_Size_Argument_T< S, Insert_Policy >.

Definition at line 14 of file Argument.cpp. 

00015 {
00016   return true;
00017 }

virtual CORBA::ParameterMode TAO::Argument::mode (  void   )  const [pure virtual]
 

Get the parameter mode of this argument.

Implemented in TAO::InArgument, TAO::InoutArgument, TAO::OutArgument, and TAO::RetArgument.

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 13:17:29 2008 for TAO by doxygen 1.3.6