Represents a single position that is transferable between modules by connectors. More...

#include <WSinglePosition.h>

Inheritance diagram for WSinglePosition:

Collaboration diagram for WSinglePosition:

Public Types
typedef std::shared_ptr< WSinglePosition >	SPtr
	Shared pointer abbreviation. More...

typedef std::shared_ptr< const WSinglePosition >	ConstSPtr
	Const shared pointer abbreviation. More...

Public Member Functions
	WSinglePosition (const WPosition &position)
	Copies the specified WPosition instance. More...

	WSinglePosition ()
	Constructs an empty position. More...

virtual	~WSinglePosition ()
	Destructs. More...

virtual const std::string	getName () const
	The name of this transferable. More...

virtual const std::string	getDescription () const
	The description of this transferable. More...

Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor. More...

virtual	~WTransferable ()
	Destructor. More...

Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor. More...

virtual	~WPrototyped ()
	Destructor. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Static Public Member Functions
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Protected Attributes
static std::shared_ptr< WPrototyped >	m_prototype = std::shared_ptr< WPrototyped >()
	Prototype for this dataset. More...

Detailed Description

Represents a single position that is transferable between modules by connectors.

Definition at line 37 of file WSinglePosition.h.

Member Typedef Documentation

◆ ConstSPtr

typedef std::shared_ptr< const WSinglePosition > WSinglePosition::ConstSPtr

Const shared pointer abbreviation.

Definition at line 48 of file WSinglePosition.h.

◆ SPtr

typedef std::shared_ptr< WSinglePosition > WSinglePosition::SPtr

Shared pointer abbreviation.

Definition at line 43 of file WSinglePosition.h.

Constructor & Destructor Documentation

◆ WSinglePosition() [1/2]

WSinglePosition::WSinglePosition ( const WPosition & position )

explicit

Copies the specified WPosition instance.

Parameters

position the instance to clone.

Definition at line 40 of file WSinglePosition.cpp.

◆ WSinglePosition() [2/2]

WSinglePosition::WSinglePosition ( )

Constructs an empty position.

Definition at line 34 of file WSinglePosition.cpp.

Referenced by getPrototype().

Here is the caller graph for this function:

◆ ~WSinglePosition()

WSinglePosition::~WSinglePosition ( )

virtual

Destructs.

Definition at line 46 of file WSinglePosition.cpp.

Member Function Documentation

◆ getDescription()

const std::string WSinglePosition::getDescription ( ) const

inlinevirtual

The description of this transferable.

This is useful information for the users.

Returns: A description

Implements WPrototyped.

Definition at line 101 of file WSinglePosition.h.

◆ getName()

const std::string WSinglePosition::getName ( ) const

inlinevirtual

The name of this transferable.

This is useful information for the users.

Returns: the name.

Implements WPrototyped.

Definition at line 96 of file WSinglePosition.h.

◆ getPrototype()

std::shared_ptr< WPrototyped > WSinglePosition::getPrototype ( )

static

Returns a prototype instantiated with the true type of the deriving class.

Returns: the prototype.

Definition at line 50 of file WSinglePosition.cpp.

References m_prototype, and WSinglePosition().

Here is the call graph for this function:

Member Data Documentation

◆ m_prototype

std::shared_ptr< WPrototyped > WSinglePosition::m_prototype = std::shared_ptr< WPrototyped >()

staticprotected

Prototype for this dataset.

Definition at line 93 of file WSinglePosition.h.