kanzi::MessageArguments Struct Reference

Message arguments is the base class for arguments passed in messages. More...

#include <kanzi/message/message_arguments.hpp>

Inheritance diagram for kanzi::MessageArguments:

Classes
struct	ArgumentEntry

Public Types
typedef vector< ArgumentEntry >	ArgumentContainer
typedef ArgumentContainer::iterator	ArgumentIterator

Public Member Functions
	MessageArguments ()
	MessageArguments (AbstractMessageType messageType)
	MessageArguments (const KzuMessageType *messageType)
	~MessageArguments ()
template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, TDataType value)
void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
bool	isFrom (const Node &source) const
shared_ptr< Node >	getSource () const
void	setHandled (bool handled)
bool	isHandled () const
chrono::milliseconds	getTimestamp () const
KzuMessageDispatcher *	getDispatcher () const
AbstractMessageType	getType () const
void	setSource (Node *source)
void	setTimestamp (chrono::milliseconds timestamp)
void	setValid (bool valid)
bool	isValid () const
void	copy_internal (MessageArguments &other) const
ArgumentEntry *	acquireArgument (AbstractPropertyType argumentType)
ArgumentEntry *	findArgument (AbstractPropertyType argumentType)
const ArgumentEntry *	findArgument (AbstractPropertyType argumentType) const
template<>
float	getArgument (const PropertyType< float > &propertyType) const
template<>
void	setArgument (const PropertyType< float > &propertyType, float value)
template<>
int	getArgument (const PropertyType< int > &propertyType) const
template<>
void	setArgument (const PropertyType< int > &propertyType, int value)
template<>
bool	getArgument (const PropertyType< bool > &propertyType) const
template<>
void	setArgument (const PropertyType< bool > &propertyType, bool value)
template<>
ColorRGBA	getArgument (const PropertyType< ColorRGBA > &propertyType) const
template<>
void	setArgument (const PropertyType< ColorRGBA > &propertyType, ColorRGBA value)
template<>
Vector2	getArgument (const PropertyType< Vector2 > &propertyType) const
template<>
void	setArgument (const PropertyType< Vector2 > &propertyType, Vector2 value)
template<>
Vector3	getArgument (const PropertyType< Vector3 > &propertyType) const
template<>
void	setArgument (const PropertyType< Vector3 > &propertyType, Vector3 value)
template<>
Vector4	getArgument (const PropertyType< Vector4 > &propertyType) const
template<>
void	setArgument (const PropertyType< Vector4 > &propertyType, Vector4 value)
template<>
Matrix3x3	getArgument (const PropertyType< Matrix3x3 > &propertyType) const
template<>
void	setArgument (const PropertyType< Matrix3x3 > &propertyType, Matrix3x3 value)
template<>
Matrix4x4	getArgument (const PropertyType< Matrix4x4 > &propertyType) const
template<>
void	setArgument (const PropertyType< Matrix4x4 > &propertyType, Matrix4x4 value)
template<>
string	getArgument (const PropertyType< string > &propertyType) const
template<>
void	setArgument (const PropertyType< string > &propertyType, string value)
template<>
ResourceID	getArgument (const PropertyType< ResourceID > &propertyType) const
template<>
void	setArgument (const PropertyType< ResourceID > &propertyType, ResourceID value)
template<>
void *	getArgument (const PropertyType< void * > &propertyType) const
template<>
void	setArgument (const PropertyType< void * > &propertyType, void *value)

Static Public Member Functions
static Metaclass *	getStaticMetaclass ()
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Public Attributes
bool	m_valid
	Is message valid. More...
bool	m_handled
	Is message handled yet. More...
chrono::milliseconds	m_timestamp
	Timestamp of message. More...
KzuMessageDispatcher *	m_dispatcher
	Dispatcher assigned to the message. More...
AbstractMessageType	m_messageType
	Type of the message. More...
Node *	m_source
	Sender of the message. More...
ArgumentContainer	m_arguments
	Arguments of the message. More...

Friends
class	Node

Detailed Description

Message arguments is the base class for arguments passed in messages.

Member Typedef Documentation

typedef vector<ArgumentEntry> kanzi::MessageArguments::ArgumentContainer

typedef ArgumentContainer::iterator kanzi::MessageArguments::ArgumentIterator

Constructor & Destructor Documentation

kanzi::MessageArguments::MessageArguments ( )

explicit

kanzi::MessageArguments::MessageArguments ( AbstractMessageType  messageType )

explicit

kanzi::MessageArguments::MessageArguments ( const KzuMessageType *  messageType )

explicit

kanzi::MessageArguments::~MessageArguments

(

)

Member Function Documentation

template<typename TDataType >

TDataType kanzi::MessageArguments::getArgument

(

const PropertyType< TDataType > &

argumentType

)

const

bool kanzi::MessageArguments::getAbstractArgument	(	AbstractPropertyType	argumentType,
		Variant &	variant
	)		const

template<typename TDataType >

void kanzi::MessageArguments::setArgument	(	const PropertyType< TDataType > &	argumentType,
		TDataType	value
	)

void kanzi::MessageArguments::setAbstractArgument	(	AbstractPropertyType	argumentType,
		const Variant &	variant
	)

bool kanzi::MessageArguments::isFrom ( const Node &  source ) const

inline

shared_ptr<Node> kanzi::MessageArguments::getSource

(

)

const

void kanzi::MessageArguments::setHandled ( bool  handled )

inline

bool kanzi::MessageArguments::isHandled ( ) const

inline

chrono::milliseconds kanzi::MessageArguments::getTimestamp ( ) const

inline

KzuMessageDispatcher* kanzi::MessageArguments::getDispatcher ( ) const

inline

AbstractMessageType kanzi::MessageArguments::getType ( ) const

inline

static Metaclass* kanzi::MessageArguments::getStaticMetaclass ( )

inlinestatic

void kanzi::MessageArguments::setSource ( Node *  source )

inline

void kanzi::MessageArguments::setTimestamp ( chrono::milliseconds  timestamp )

inline

void kanzi::MessageArguments::setValid ( bool  valid )

inline

bool kanzi::MessageArguments::isValid ( ) const

inline

void kanzi::MessageArguments::copy_internal

(

MessageArguments &

other

)

const

ArgumentEntry* kanzi::MessageArguments::acquireArgument

(

AbstractPropertyType

argumentType

)

ArgumentEntry* kanzi::MessageArguments::findArgument

(

AbstractPropertyType

argumentType

)

const ArgumentEntry* kanzi::MessageArguments::findArgument

(

AbstractPropertyType

argumentType

)

const

static PropertyTypeEditorInfoSharedPtr kanzi::MessageArguments::makeEditorInfo ( )

inlinestatic

template<>

float kanzi::MessageArguments::getArgument ( const PropertyType< float > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< float > &  propertyType, float  value  )

inline

template<>

int kanzi::MessageArguments::getArgument ( const PropertyType< int > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< int > &  propertyType, int  value  )

inline

template<>

bool kanzi::MessageArguments::getArgument ( const PropertyType< bool > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< bool > &  propertyType, bool  value  )

inline

template<>

ColorRGBA kanzi::MessageArguments::getArgument ( const PropertyType< ColorRGBA > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< ColorRGBA > &  propertyType, ColorRGBA  value  )

inline

template<>

Vector2 kanzi::MessageArguments::getArgument ( const PropertyType< Vector2 > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< Vector2 > &  propertyType, Vector2  value  )

inline

template<>

Vector3 kanzi::MessageArguments::getArgument ( const PropertyType< Vector3 > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< Vector3 > &  propertyType, Vector3  value  )

inline

template<>

Vector4 kanzi::MessageArguments::getArgument ( const PropertyType< Vector4 > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< Vector4 > &  propertyType, Vector4  value  )

inline

template<>

Matrix3x3 kanzi::MessageArguments::getArgument ( const PropertyType< Matrix3x3 > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< Matrix3x3 > &  propertyType, Matrix3x3  value  )

inline

template<>

Matrix4x4 kanzi::MessageArguments::getArgument ( const PropertyType< Matrix4x4 > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< Matrix4x4 > &  propertyType, Matrix4x4  value  )

inline

template<>

string kanzi::MessageArguments::getArgument ( const PropertyType< string > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< string > &  propertyType, string  value  )

inline

template<>

ResourceID kanzi::MessageArguments::getArgument ( const PropertyType< ResourceID > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< ResourceID > &  propertyType, ResourceID  value  )

inline

template<>

void* kanzi::MessageArguments::getArgument ( const PropertyType< void * > &  propertyType ) const

inline

template<>

void kanzi::MessageArguments::setArgument ( const PropertyType< void * > &  propertyType, void *  value  )

inline

Friends And Related Function Documentation

friend class Node

friend

Member Data Documentation

bool kanzi::MessageArguments::m_valid

Is message valid.

bool kanzi::MessageArguments::m_handled

Is message handled yet.

chrono::milliseconds kanzi::MessageArguments::m_timestamp

Timestamp of message.

KzuMessageDispatcher* kanzi::MessageArguments::m_dispatcher

Dispatcher assigned to the message.

AbstractMessageType kanzi::MessageArguments::m_messageType

Type of the message.

Node* kanzi::MessageArguments::m_source

Sender of the message.

ArgumentContainer kanzi::MessageArguments::m_arguments

Arguments of the message.

---

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

• kanzi/message/message_arguments.hpp