vrecko::IOPinBase Class Reference

Base class that defines the very basic method that every IO pin will have. More...

#include <BaseClass.h>

Inheritance diagram for vrecko::IOPinBase:

Public Member Functions
std::string &	getPinName ()
	Returns the name of the current IO pin. Every pin must have a name that is unique in its ability and in its "type", i.e. two input pins with the same name should exist, but you can create input and also output pins with the identical name. More...
virtual VreckoMessage *	createCompatibleMessage ()=0
	Creates an instance of a message type that is recognized by this input/output. More...

Protected Attributes
std::string	pinName
BaseClass *	owner

Detailed Description

Base class that defines the very basic method that every IO pin will have.

The input or output pins are the basis for message sending between objects in Vrecko. All the usual messages should pass through some output pin and are received in other object's input pin.

Author

Vit Kovalcik

Date

2011

Member Function Documentation

virtual VreckoMessage* vrecko::IOPinBase::createCompatibleMessage ( )

pure virtual

Creates an instance of a message type that is recognized by this input/output.

If you will create a new descendant class of type XY, this method will generally be:

virtual VreckoMessage* createCompatibleMessage() { return new XY; };

Returns

(VreckoMessage*)

Implemented in vrecko::RequestOutputPin< _MessageType, _ReturningMessageType >, vrecko::RequestInputPin< _MessageType, _ReturningMessageType >, vrecko::OutputPin< _MessageType >, and vrecko::InputPin< _MessageType >.

std::string& vrecko::IOPinBase::getPinName ( )

inline

Returns the name of the current IO pin. Every pin must have a name that is unique in its ability and in its "type", i.e. two input pins with the same name should exist, but you can create input and also output pins with the identical name.

Returns

(std::string&) Reference to a pin name.

Member Data Documentation

BaseClass* vrecko::IOPinBase::owner

protected

std::string vrecko::IOPinBase::pinName

protected

---

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

• C:/Documents/School/OSG/VRECKO/include/vrecko/BaseClass.h