lestes::msg::message_stencil1< P0 > Class Template Reference

Message stencil. More...

#include <message_stencil.hh>

Inheritance diagram for lestes::msg::message_stencil1< P0 >:

List of all members.

Public Types
typedef formatter< P0 >	f0_type
	The type of formatter for zeroth parameter.
Public Member Functions
ptr< message >	format (const P0 &p0) const
	Formats a message according to the stencil.
Static Public Member Functions
static ptr< message_stencil1< P0 > >	create (const lstring &a_format, flags_type a_flags, const ptr< f0_type > &a_f0)
	Returns new stencil.
Protected Member Functions
	message_stencil1 (const lstring &a_format, flags_type a_flags, const ptr< f0_type > &a_f0)
	Creates new stencil.
void	gc_mark (void)
	Marks the object.
Private Member Functions
	message_stencil1 (const message_stencil1< P0 > &)
	Hides copy constructor.
message_stencil1< P0 > &	operator= (const message_stencil1< P0 > &)
	Hides assignment operator.
Private Attributes
srp< f0_type >	f0
	The formatter for the zeroth parameter.

---

Detailed Description

template<typename P0>
class lestes::msg::message_stencil1< P0 >

Message stencil.

Represents message stencil with one formatted parameter.

Parameters:

P0

The type of the zeroth parameter.

Definition at line 190 of file message_stencil.hh.

---

Member Typedef Documentation

template<typename P0>

typedef formatter<P0> lestes::msg::message_stencil1< P0 >::f0_type

The type of formatter for zeroth parameter.

Definition at line 193 of file message_stencil.hh.

---

Constructor & Destructor Documentation

template<typename P0>

lestes::msg::message_stencil1< P0 >::message_stencil1	(	const lstring &	a_text,
		flags_type	a_flags,
		const ptr< f0_type > &	a_f0
	)			[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.

Definition at line 231 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil1< P0 >::create().

                                         :
        message_stencil(1,a_text,a_flags),
        f0(checked(a_f0))
{
}

template<typename P0>

lestes::msg::message_stencil1< P0 >::message_stencil1

(

const message_stencil1< P0 > &

)

[private]

Hides copy constructor.

---

Member Function Documentation

template<typename P0>

ptr< message > lestes::msg::message_stencil1< P0 >::format

(

const P0 &

p0

)

const [inline]

Formats a message according to the stencil.

Formats a messge from the stencil.

Parameters:

p0

The zeroth parameter to format.

Returns:

The formatted message.

Definition at line 244 of file message_stencil.hh.

References lestes::std::vector< T >::create(), lestes::msg::message_stencil1< P0 >::f0, and lestes::msg::message_stencil::generate().

{
        ptr<args_type> args = args_type::create();
        args->push_back(f0->format(p0));
        return generate(args);
}

template<typename P0>

ptr< message_stencil1< P0 > > lestes::msg::message_stencil1< P0 >::create	(	const lstring &	a_format,
		flags_type	a_flags,
		const ptr< f0_type > &	a_f0
	)			[inline, static]

Returns new stencil.

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

Precondition:

The format string is well-formed.

a_f0 != 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.

Returns:

The stencil with given values.

Definition at line 261 of file message_stencil.hh.

References lestes::msg::message_stencil1< P0 >::message_stencil1().

{
        return new message_stencil1(a_format,a_flags,a_f0);
}

template<typename P0>

void lestes::msg::message_stencil1< P0 >::gc_mark

(

void

)

[inline, protected, virtual]

Marks the object.

Marks the object for garbage collection.

Reimplemented from lestes::msg::message_stencil.

Definition at line 218 of file message_stencil.hh.

References lestes::msg::message_stencil1< P0 >::f0, and lestes::msg::message_stencil::gc_mark().

{
        f0.gc_mark();
        message_stencil::gc_mark();
}

template<typename P0>

message_stencil1<P0>& lestes::msg::message_stencil1< P0 >::operator=

(

const message_stencil1< P0 > &

)

[private]

Hides assignment operator.

---

Member Data Documentation

template<typename P0>

srp<f0_type> lestes::msg::message_stencil1< P0 >::f0 [private]

The formatter for the zeroth parameter.

Definition at line 207 of file message_stencil.hh.

Referenced by lestes::msg::message_stencil1< P0 >::format(), and lestes::msg::message_stencil1< P0 >::gc_mark().

---

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

• message_stencil.hh

---