Ocean::MessageObject< false > Class Reference

Specialization of MessageObject. More...

#include <Messenger.h>

Inheritance diagram for Ocean::MessageObject< false >:

Public Types
using	MessageType = Messenger::MessageType
	Re-definition of MessageType.

Public Member Functions
	MessageObject (const MessageType)
	Creates a new message object.
	MessageObject (const MessageType, std::string &&)
	Creates a new message object.
	MessageObject (const MessageObject &messageObject)=default
	Copy-constructs a new message object.
	~MessageObject ()=default
	Destructs a message object.
MessageObject &	newLine ()
	Adds a new line to this message object if a specified condition holds.
MessageObject &	newLine (const bool)
	Adds a new line to this message object if a specified condition holds.
MessageObject &	operator<< (std::string &&)
	Pushes another information message.
MessageObject &	operator<< (const std::string &)
	Pushes another information message.
MessageObject &	operator<< (const char *)
	Pushes another information message.
MessageObject &	operator<< (const double)
	Pushes another information message.
MessageObject &	operator<< (const float)
	Pushes another information message.
MessageObject &	operator<< (const int)
	Pushes another information message.
MessageObject &	operator<< (const unsigned int)
	Pushes another information message.
MessageObject &	operator<< (const long)
	Pushes another information message.
MessageObject &	operator<< (const long long)
	Pushes another information message.
MessageObject &	operator<< (const unsigned long long)
	Pushes another information message.
MessageObject &	operator<< (const long unsigned int)
	Pushes another information message.
void	operator<< (const MessageObject &)
	Pushes another information message.
MessageObject &	operator= (const MessageObject &messageObject)=default
	Assign operator.

Protected Member Functions
	MessageObject (const MessageType, std::string &&, std::string &&)
	Creates a new message object.

Protected Attributes
std::string	message_
	Entire message.
std::string	location_
	Location of the message.
Messenger::MessageType	type_
	Type of this messenger.

Detailed Description

Specialization of MessageObject.

Inactive messenger object to strip away any messenger related information in binary.

See also

Messenger.

Member Typedef Documentation

MessageType

using Ocean::MessageObject< false >::MessageType = Messenger::MessageType

Re-definition of MessageType.

Constructor & Destructor Documentation

MessageObject() [1/4]

Ocean::MessageObject< false >::MessageObject ( const MessageType )

inlineexplicit

Creates a new message object.

MessageObject() [2/4]

Ocean::MessageObject< false >::MessageObject ( const MessageType , std::string &&  )

inline

Creates a new message object.

MessageObject() [3/4]

Ocean::MessageObject< false >::MessageObject ( const MessageObject< false > & messageObject )

default

Copy-constructs a new message object.

Parameters

messageObject

Another instance that will be used to create this instance, must be valid

~MessageObject()

Ocean::MessageObject< false >::~MessageObject ( )

default

Destructs a message object.

MessageObject() [4/4]

Ocean::MessageObject< false >::MessageObject ( const MessageType , std::string && , std::string &&  )

inlineprotected

Creates a new message object.

Member Function Documentation

newLine() [1/2]

MessageObject & Ocean::MessageObject< false >::newLine ( )

inline

Adds a new line to this message object if a specified condition holds.

Returns

Reference to this object

newLine() [2/2]

MessageObject & Ocean::MessageObject< false >::newLine ( const bool )

inline

Adds a new line to this message object if a specified condition holds.

Returns

Reference to this object

operator<<() [1/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const char * )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [2/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const double )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [3/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const float )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [4/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const int )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [5/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const long long )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [6/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const long unsigned int )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [7/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const long )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [8/12]

void Ocean::MessageObject< false >::operator<< ( const MessageObject< false > & )

inline

Pushes another information message.

operator<<() [9/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const std::string & )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [10/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const unsigned int )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [11/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( const unsigned long long )

inline

Pushes another information message.

Returns

Reference to this object

operator<<() [12/12]

MessageObject & Ocean::MessageObject< false >::operator<< ( std::string && )

inline

Pushes another information message.

Returns

Reference to this object

operator=()

MessageObject & Ocean::MessageObject< false >::operator= ( const MessageObject< false > & messageObject )

default

Assign operator.

Parameters

messageObject

Another instance that will assigned to this instance, must be valid

Field Documentation

location_

std::string Ocean::MessageObject< tActive >::location_

protected

Location of the message.

message_

std::string Ocean::MessageObject< tActive >::message_

protected

Entire message.

type_

Messenger::MessageType Ocean::MessageObject< tActive >::type_

protected

Type of this messenger.

---

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

• Messenger.h