lestes::msg::message_stencil3

lestes::msg::message_stencil3< P0, P1, P2 > Class Template Reference

Message stencil. More...

#include <message_stencil.hh>

Inheritance diagram for lestes::msg::message_stencil3< P0, P1, P2 >:

lestes::msg::message_stencil lestes::std::object lestes::std::mem::keystone List of all members.

Public Types

typedef formatter< P0 > f0_type
 The type of formatter for zeroth parameter.
typedef formatter< P1 > f1_type
 The type of formatter for first parameter.
typedef formatter< P2 > f2_type
 The type of formatter for second parameter.

Public Member Functions

ptr< message > format (const P0 &p0, const P1 &p1, const P2 &p2) const
 Formats a message according to the stencil.

Static Public Member Functions

static ptr< message_stencil3<
P0, P1, P2 > > 		create (const lstring &a_format, flags_type a_flags, const ptr< f0_type > &a_f0, const ptr< f1_type > &a_f1, const ptr< f2_type > &a_f2)
 Returns new stencil.

Protected Member Functions

 message_stencil3 (const lstring &a_format, flags_type a_flags, const ptr< f0_type > &a_f0, const ptr< f1_type > &a_f1, const ptr< f2_type > &a_f2)
 Creates new stencil.
void gc_mark (void)
 Marks the object.

Private Member Functions

 message_stencil3 (const message_stencil3< P0, P1, P2 > &)
 Hides copy constructor.
message_stencil3< P0, P1,
P2 > & 		operator= (const message_stencil3< P0, P1, P2 > &)
 Hides assignment operator.

Private Attributes

srp< f0_type > f0
 The formatter for the zeroth parameter.
srp< f1_type > f1
 The formatter for the first parameter.
srp< f2_type > f2
 The formatter for the second parameter.

Detailed Description

template<typename P0, typename P1, typename P2>
class lestes::msg::message_stencil3< P0, P1, P2 >

Message stencil.

Represents message stencil with three formatted parameters.

Parameters:
P0 The type of the zeroth parameter.
P1 The type of the first parameter.
P1 The type of the second parameter.

Definition at line 372 of file message_stencil.hh.

Member Typedef Documentation

template<typename P0, typename P1, typename P2>
typedef formatter<P0> lestes::msg::message_stencil3< P0, P1, P2 >::f0_type

The type of formatter for zeroth parameter.

Definition at line 375 of file message_stencil.hh.

template<typename P0, typename P1, typename P2>
typedef formatter<P1> lestes::msg::message_stencil3< P0, P1, P2 >::f1_type

The type of formatter for first parameter.

Definition at line 377 of file message_stencil.hh.

template<typename P0, typename P1, typename P2>
typedef formatter<P2> lestes::msg::message_stencil3< P0, P1, P2 >::f2_type

The type of formatter for second parameter.

Definition at line 379 of file message_stencil.hh.

Constructor & Destructor Documentation

template<typename P0, typename P1, typename P2>
lestes::msg::message_stencil3< P0, P1, P2 >::message_stencil3 ( const lstring &  a_text,
flags_type  a_flags,
const ptr< f0_type > &  a_f0,
const ptr< f1_type > &  a_f1,
const ptr< f2_type > &  a_f2 
) [inline, protected]

Creates new stencil.

Creates the stencil.

Parameters:
a_format The message format.
a_flags The message flags.
a_f0 The formatter for the zeroth parameter.
a_f1 The formatter for the first parameter.
a_f2 The formatter for the second parameter.

Definition at line 426 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::create().

00427                                                                                              :
00428         message_stencil(3,a_text,a_flags),
00429         f0(checked(a_f0)),
00430         f1(checked(a_f1)),
00431         f2(checked(a_f2))
00432 {
00433 }

template<typename P0, typename P1, typename P2>
lestes::msg::message_stencil3< P0, P1, P2 >::message_stencil3 ( const message_stencil3< P0, P1, P2 > &   )  [private]

Hides copy constructor.

Member Function Documentation

template<typename P0, typename P1, typename P2>
ptr< message > lestes::msg::message_stencil3< P0, P1, P2 >::format ( const P0 &  p0,
const P1 &  p1,
const P2 &  p2 
) const [inline]

Formats a message according to the stencil.

Formats a messge from the stencil.

Parameters:
p0 The zeroth argument to format.
p1 The first argument to format.
p2 The second argument to format.
Returns:
The formatted message.

Definition at line 443 of file message_stencil.hh.

References lestes::std::vector< T >::create(), lestes::msg::message_stencil3< P0, P1, P2 >::f0, lestes::msg::message_stencil3< P0, P1, P2 >::f1, lestes::msg::message_stencil3< P0, P1, P2 >::f2, and lestes::msg::message_stencil::generate().

00444 {
00445         ptr<args_type> args = args_type::create();
00446         args->push_back(f0->format(p0));
00447         args->push_back(f1->format(p1));
00448         args->push_back(f2->format(p2));
00449         return generate(args);
00450 }

template<typename P0, typename P1, typename P2>
ptr< message_stencil3< P0, P1, P2 > > lestes::msg::message_stencil3< P0, P1, P2 >::create ( const lstring &  a_format,
flags_type  a_flags,
const ptr< f0_type > &  a_f0,
const ptr< f1_type > &  a_f1,
const ptr< f2_type > &  a_f2 
) [inline, static]

Returns new stencil.

Returns the two-parameter stencil, initializes with values to fill into the message.

Precondition:
The format string is well-formed.

a_f0 != NULL

a_f1 != NULL

a_f2 != NULL

Parameters:
a_format The format for the message, with % designating indexed parameter slots.
a_flags The flags for the message.
a_f0 The formatter for the zeroth parameter.
a_f1 The formatter for the first parameter.
a_f2 The formatter for the second parameter.
Returns:
The stencil with given values.

Definition at line 466 of file message_stencil.hh.

References lestes::msg::message_stencil3< P0, P1, P2 >::message_stencil3().

00468 {
00469         return new message_stencil3(a_format,a_flags,a_f0,a_f1,a_f2);
00470 }

template<typename P0, typename P1, typename P2>
void lestes::msg::message_stencil3< P0, P1, P2 >::gc_mark ( void   )  [inline, protected, virtual]

Marks the object.

Marks the object for garbage collection.

Reimplemented from lestes::msg::message_stencil.

Definition at line 409 of file message_stencil.hh.

References lestes::msg::message_stencil3< P0, P1, P2 >::f0, lestes::msg::message_stencil3< P0, P1, P2 >::f1, lestes::msg::message_stencil3< P0, P1, P2 >::f2, and lestes::msg::message_stencil::gc_mark().

00410 {
00411         f0.gc_mark();
00412         f1.gc_mark();
00413         f2.gc_mark();
00414         message_stencil::gc_mark();
00415 }

template<typename P0, typename P1, typename P2>
message_stencil3<P0,P1,P2>& lestes::msg::message_stencil3< P0, P1, P2 >::operator= ( const message_stencil3< P0, P1, P2 > &   )  [private]

Hides assignment operator.

Member Data Documentation

template<typename P0, typename P1, typename P2>
srp<f0_type> lestes::msg::message_stencil3< P0, P1, P2 >::f0 [private]

The formatter for the zeroth parameter.

Definition at line 394 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::format(), and lestes::msg::message_stencil3< P0, P1, P2 >::gc_mark().

template<typename P0, typename P1, typename P2>
srp<f1_type> lestes::msg::message_stencil3< P0, P1, P2 >::f1 [private]

The formatter for the first parameter.

Definition at line 396 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::format(), and lestes::msg::message_stencil3< P0, P1, P2 >::gc_mark().

template<typename P0, typename P1, typename P2>
srp<f2_type> lestes::msg::message_stencil3< P0, P1, P2 >::f2 [private]

The formatter for the second parameter.

Definition at line 398 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::format(), and lestes::msg::message_stencil3< P0, P1, P2 >::gc_mark().

The documentation for this class was generated from the following file:
Generated on Mon Feb 12 18:25:54 2007 for lestes by doxygen 1.5.1-20070107