TAO::String_var< charT > Class Template Reference

#include <CORBA_String.h>

List of all members.

Public Types
typedef charT	character_type
typedef TAO::details::string_traits_base < character_type >	s_traits
Public Member Functions
	String_var (void)
	Default constructor.
	String_var (character_type *p)
	Constructor, owns p.
	String_var (const character_type *p)
	Constructor. Makes a copy of p.
	String_var (String_var< charT > const &s)
	Copy constructor.
	~String_var (void)
	Destructor.
String_var &	operator= (character_type *p)
	Assignment operator.
String_var &	operator= (const character_type *p)
	Assignment to a const char*. Makes a copy.
String_var &	operator= (String_var< character_type > const &s)
	Assignment operator.
	operator character_type *& ()
	Spec-defined read/write version.
	operator const character_type * () const
	Only read privileges.
character_type &	operator[] (CORBA::ULong slot)
	Allows access and modification using an slot.
character_type	operator[] (CORBA::ULong slot) const
	Allows only accessing thru an slot.
const character_type *	in (void) const
	For in parameter.
character_type *&	inout (void)
	For inout parameter.
character_type *&	out (void)
	For out parameter.
character_type *	_retn (void)
	For string of return type.
Private Attributes
character_type *	ptr_
	Instance.

---

Detailed Description

template<typename charT>
class TAO::String_var< charT >

Provides automatic deallocation of storage for the string once it goes out of scope.

Definition at line 50 of file CORBA_String.h.

---

Member Typedef Documentation

template<typename charT>

typedef charT TAO::String_var< charT >::character_type

Definition at line 53 of file CORBA_String.h.

template<typename charT>

typedef TAO::details::string_traits_base<character_type> TAO::String_var< charT >::s_traits

Definition at line 54 of file CORBA_String.h.

---

Constructor & Destructor Documentation

template<typename charT>

TAO::String_var< charT >::String_var

(

void

)

[inline]

Default constructor.

Definition at line 57 of file CORBA_String.h.

                             : ptr_ (0)
    {
    }

template<typename charT>

TAO::String_var< charT >::String_var

(

character_type *

p

)

[inline]

Constructor, owns p.

Definition at line 62 of file CORBA_String.h.

                                          : ptr_ (p)
    {
    }

template<typename charT>

TAO::String_var< charT >::String_var

(

const character_type *

p

)

[inline]

Constructor. Makes a copy of p.

Definition at line 67 of file CORBA_String.h.

                                                : ptr_ (s_traits::duplicate (p))
    {
    }

template<typename charT>

TAO::String_var< charT >::String_var

(

String_var< charT > const &

s

)

[inline]

Copy constructor.

Definition at line 72 of file CORBA_String.h.

                                                   : ptr_(s_traits::duplicate(s.ptr_))
    {
    }

template<typename charT>

TAO::String_var< charT >::~String_var

(

void

)

[inline]

Destructor.

Definition at line 77 of file CORBA_String.h.

    {
      s_traits::release (this->ptr_);
    }

---

Member Function Documentation

template<typename charT>

character_type* TAO::String_var< charT >::_retn

(

void

)

[inline]

For string of return type.

Definition at line 153 of file CORBA_String.h.

    {
      character_type *temp = this->ptr_;
      this->ptr_ = 0;
      return temp;
    }

template<typename charT>

const character_type* TAO::String_var< charT >::in

(

void

)

const [inline]

For in parameter.

Definition at line 133 of file CORBA_String.h.

    {
      return this->ptr_;
    }

template<typename charT>

character_type*& TAO::String_var< charT >::inout

(

void

)

[inline]

For inout parameter.

Definition at line 139 of file CORBA_String.h.

    {
      return this->ptr_;
    }

template<typename charT>

TAO::String_var< charT >::operator character_type *&

(

)

[inline]

Spec-defined read/write version.

Definition at line 107 of file CORBA_String.h.

    {
      return this->ptr_;
    }

template<typename charT>

TAO::String_var< charT >::operator const character_type *

(

)

const [inline]

Only read privileges.

Definition at line 113 of file CORBA_String.h.

    {
      return this->ptr_;
    }

template<typename charT>

String_var& TAO::String_var< charT >::operator=

(

const character_type *

p

)

[inline]

Assignment to a const char*. Makes a copy.

Definition at line 91 of file CORBA_String.h.

    {
      String_var <charT> tmp (p);
      std::swap (this->ptr_, tmp.ptr_);
      return *this;
    }

template<typename charT>

String_var& TAO::String_var< charT >::operator=

(

character_type *

p

)

[inline]

Assignment operator.

Definition at line 83 of file CORBA_String.h.

    {
      String_var <charT> tmp (p);
      std::swap (this->ptr_, tmp.ptr_);
      return *this;
    }

template<typename charT>

String_var& TAO::String_var< charT >::operator=

(

String_var< character_type > const &

s

)

[inline]

Assignment operator.

Definition at line 99 of file CORBA_String.h.

    {
      String_var <charT> tmp (s);
      std::swap (this->ptr_, tmp.ptr_);
      return *this;
    }

template<typename charT>

character_type& TAO::String_var< charT >::operator[]

(

CORBA::ULong

slot

)

[inline]

Allows access and modification using an slot.

Definition at line 119 of file CORBA_String.h.

    {
      // We need to verify bounds else raise some exception.
      return this->ptr_[slot];
    }

template<typename charT>

character_type TAO::String_var< charT >::operator[]

(

CORBA::ULong

slot

)

const [inline]

Allows only accessing thru an slot.

Definition at line 126 of file CORBA_String.h.

    {
      // We need to verify bounds else raise some exception.
      return this->ptr_[slot];
    }

template<typename charT>

character_type*& TAO::String_var< charT >::out

(

void

)

[inline]

For out parameter.

Definition at line 145 of file CORBA_String.h.

    {
      s_traits::release (this->ptr_);
      this->ptr_ = 0;
      return this->ptr_;
    }

---

Member Data Documentation

template<typename charT>

character_type* TAO::String_var< charT >::ptr_ [private]

Instance.

Definition at line 162 of file CORBA_String.h.

---

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

• CORBA_String.h