Contains change information for a WorldModel entity. More...

Public Member Functions
	WorldModelAction ()
	Creates an invalid default action. More...

	WorldModelAction (const WorldActionType &actionType, const std::shared_ptr< WorldEntity > entity)

	WorldModelAction (const WorldActionType &actionType, const std::shared_ptr< WorldEntity > entity, const MetaData metaData)

WorldActionType	GetActionType () const noexcept
	Returns the type of change produced by this action. More...

std::shared_ptr< WorldEntity >	GetEntity () const noexcept
	Returns the entity being changed in the world model. More...

MetaData	GetMetaData () const noexcept
	Returns the new metadata for the given entity. More...

Detailed Description

Contains change information for a WorldModel entity.

Definition at line 33 of file WorldModelAction.h.

Constructor & Destructor Documentation

weave::WorldModelAction::WorldModelAction ( )

inline

Creates an invalid default action.

Definition at line 39 of file WorldModelAction.h.

weave::WorldModelAction::WorldModelAction	(	const WorldActionType &	actionType,
		const std::shared_ptr< WorldEntity >	entity
	)

inline

Parameters

actionType	The type of change produced by this action
entity	The entity being changed in the world model

Definition at line 46 of file WorldModelAction.h.

weave::WorldModelAction::WorldModelAction	(	const WorldActionType &	actionType,
		const std::shared_ptr< WorldEntity >	entity,
		const MetaData	metaData
	)

inline

Parameters

actionType	The type of change produced by this action
entity	The entity being changed in the world model
metaData	The new metadata for the given entity. If the actionType is KEEP or DELETE, then this data is not used by the world model.

Definition at line 56 of file WorldModelAction.h.

WorldActionType weave::WorldModelAction::GetActionType ( ) const

noexcept

Returns the type of change produced by this action.

std::shared_ptr<WorldEntity> weave::WorldModelAction::GetEntity ( ) const

noexcept

Returns the entity being changed in the world model.

MetaData weave::WorldModelAction::GetMetaData ( ) const

noexcept

Returns the new metadata for the given entity.

If the actionType is KEEP or DELETE, then this data is not used by the world model.

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