OMK::InputNT

OMK::InputNT Class Reference

class InputNT defines what an input is, regardless of the encapsulated data type More...

#include <OMKInputNT.h>

Inheritance diagram for OMK::InputNT:

Inheritance graph
[legend]
Collaboration diagram for OMK::InputNT:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 InputNT (SimulatedObject &owner, const Name &nom)
 Constructor.
virtual ~InputNT ()
 Destructor.
virtual bool connect (const Name &objectName, const Name &outputName)=0
 how to connect an input to the coresponding output
virtual bool connect (SimulatedObject &object, const Name &outputName)=0
 how to connect an input to the coresponding output
virtual bool connect (SimulatedObject *pointerToObject, const Name &outputName)=0
 how to connect an input to the coresponding output
virtual const OutputNT * getConnectedOutput () const=0
 get a pointer to output this input is connected to
virtual void disconnect ()=0
 disconnect the input from the connected output
virtual bool isConnected ()=0
 return true if the input is connected
virtual void registerMe ()
 add the input to list of inputs of the owner
virtual bool realConnect (OutputNT *output)=0
 the real connecting member function

Detailed Description

class InputNT defines what an input is, regardless of the encapsulated data type

Definition at line 33 of file OMKInputNT.h.

Constructor & Destructor Documentation

InputNT::InputNT ( SimulatedObject &  owner,
const Name &  nom 
)

Constructor.

Definition at line 25 of file OMKInputNT.cpp.

00026   : KernelAttribute( owner, inputName )
00027 {
00028 }

InputNT::~InputNT (  )  [virtual]

Destructor.

Definition at line 32 of file OMKInputNT.cpp.

00033 {
00034 }

Member Function Documentation

virtual bool OMK::InputNT::connect ( const Name &  objectName,
const Name &  outputName 
) [pure virtual]

how to connect an input to the coresponding output

Parameters:
objectName the object owning outputName
outputName the name of the output to be connected to
Returns:
bool connecting successfull

Implemented in OMK::AbstractInput< Type >, OMK::Input< T >, OMK::InputAlias< T >, OMK::AbstractInput< ModelType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< bool > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< float > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< T > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< PrmType > >, OMK::AbstractInput< T >, OMK::AbstractInput< PrmType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< Type > >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::Iii::SharedConnectorT< Type >::connect(), OMK::Iii::SimpleConnectorT< Type >::connect(), and OMK::IAttribute::connectTo().

virtual bool OMK::InputNT::connect ( SimulatedObject &  object,
const Name &  outputName 
) [pure virtual]

how to connect an input to the coresponding output

Parameters:
object the object owning outputName
outputName the name of the output to be connected to
Returns:
bool connection successfull

Implemented in OMK::AbstractInput< Type >, OMK::Input< T >, OMK::InputAlias< T >, OMK::AbstractInput< ModelType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< bool > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< float > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< T > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< PrmType > >, OMK::AbstractInput< T >, OMK::AbstractInput< PrmType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< Type > >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

virtual bool OMK::InputNT::connect ( SimulatedObject *  pointerToObject,
const Name &  outputName 
) [pure virtual]

how to connect an input to the coresponding output

Parameters:
pointerToObject the object owning outputName
outputName the name of the output to be connected to
Returns:
bool connection successfull

Implemented in OMK::AbstractInput< Type >, OMK::Input< T >, OMK::InputAlias< T >, OMK::AbstractInput< ModelType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< bool > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< float > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< T > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< PrmType > >, OMK::AbstractInput< T >, OMK::AbstractInput< PrmType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< Type > >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

virtual const OutputNT* OMK::InputNT::getConnectedOutput (  )  const [pure virtual]

get a pointer to output this input is connected to

Implemented in OMK::AbstractInput< Type >, OMK::Input< T >, OMK::InputAlias< T >, OMK::AbstractInput< ModelType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< bool > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< float > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< T > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< PrmType > >, OMK::AbstractInput< T >, OMK::AbstractInput< PrmType >, OMK::AbstractInput< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::AbstractInput< OMK::Type::SimpleTypeT< Type > >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::Tracker::computeParameters(), OMK::Iii::SimpleConnectorT< Type >::isConnected(), and OMK::Iii::JointExtension::postComputeParameters().

virtual void OMK::InputNT::disconnect (  )  [pure virtual]

disconnect the input from the connected output

Implemented in OMK::Input< T >, OMK::InputAlias< T >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::InputAlias< T >::disconnect(), OMK::IAttribute::disconnect(), and OMK::Iii::SimpleConnectorT< Type >::disconnect().

virtual bool OMK::InputNT::isConnected (  )  [pure virtual]

return true if the input is connected

Implemented in OMK::Input< T >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::Input< OMK::Type::SimpleTypeT< Type > >.

void InputNT::registerMe (  )  [virtual]

add the input to list of inputs of the owner

Definition at line 38 of file OMKInputNT.cpp.

References OMK::SimulatedObject::_inputTable, OMK::KernelAttribute::_name, and OMK::KernelAttribute::_owner.

Referenced by OMK::AbstractInput< Type >::AbstractInput().

00039 {
00040   _owner._inputTable.addObjectWithIndex( _name, this ) ;
00041 }

virtual bool OMK::InputNT::realConnect ( OutputNT *  output  )  [pure virtual]

the real connecting member function

Parameters:
output a pointer to the real output to connect to
Returns:
connection was successfull

Implemented in OMK::Input< T >, OMK::InputAlias< T >, OMK::Input< ModelType >, OMK::Input< OMK::Type::SimpleTypeT< bool > >, OMK::Input< OMK::Type::SimpleTypeT< float > >, OMK::Input< OMK::Type::SimpleTypeT< T > >, OMK::Input< OMK::Type::SimpleTypeT< PrmType > >, OMK::Input< PrmType >, OMK::Input< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Input< OMK::Type::SimpleTypeT< HBT::PostureData > >, OMK::Input< OMK::Type::SimpleTypeT< Type > >, OMK::InputAlias< ModelType >, OMK::InputAlias< OMK::Type::SimpleTypeT< bool > >, OMK::InputAlias< OMK::Type::SimpleTypeT< float > >, OMK::InputAlias< OMK::Type::SimpleTypeT< T > >, OMK::InputAlias< OMK::Type::SimpleTypeT< PrmType > >, OMK::InputAlias< PrmType >, OMK::InputAlias< Type >, OMK::InputAlias< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::InputAlias< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::OutputNT::connect(), and OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >::realConnect().

logo OpenMask

Documentation generated on Mon Jun 9 11:46:02 2008

Generated with doxygen by Dimitri van Heesch ,   1997-2007