OMK::KernelAttribute Class Reference

Base class for all attributes of a simulated object. More...

#include <OMKKernelAttribute.h>

Inheritance diagram for OMK::KernelAttribute:

[legend]Collaboration diagram for OMK::KernelAttribute:

[legend]List of all members.

Public Member Functions
	KernelAttribute (SimulatedObject &owner, const Name &attributeName)
	Constructor.
virtual	~KernelAttribute ()
	Destructor.
virtual const SimulatedObject &	getOwner () const
	get the owner of this attribute
virtual const Name &	getName () const
	get the name of the attribute
virtual void	extract (std::istream &=std::cin)=0
	extract from a stream
virtual void	insertInStream (std::ostream &=std::cout) const=0
	insert in a stream
virtual void	printDebuggingInformation (std::ostream &err) const=0
	print any usefull debugging information for this attribute
Protected Member Functions
void	touch () const
Protected Attributes
SimulatedObject &	_owner
	a reference to the owner of this attribute
const Name	_name
	name of the attribute for the owner

---

Detailed Description

Base class for all attributes of a simulated object.

Author:

Siames

Version:

1.0

Definition at line 33 of file OMKKernelAttribute.h.

---

Constructor & Destructor Documentation

KernelAttribute::KernelAttribute	(	SimulatedObject &	owner,
		const Name &	attributeName
	)

Constructor.

Parameters:

	owner	the owner of the attribute
	attributeName	the name by which this attribute is known by it's owner

Definition at line 25 of file OMKKernelAttribute.cpp.

  : Flowable(),
    _owner( owner ),
    _name( attributeName )
{
}

KernelAttribute::~KernelAttribute

(

)

[virtual]

Destructor.

Definition at line 35 of file OMKKernelAttribute.cpp.

{
}

---

Member Function Documentation

const SimulatedObject & KernelAttribute::getOwner

(

)

const [virtual]

get the owner of this attribute

Definition at line 41 of file OMKKernelAttribute.cpp.

References _owner.

Referenced by OMK::UnInitialisedAttributeException::insertInStream(), and OMK::Iii::SimpleConnectorT< Type >::isConnected().

{
  return _owner ;
}

const Name & KernelAttribute::getName

(

)

const [virtual]

get the name of the attribute

Definition at line 48 of file OMKKernelAttribute.cpp.

References _name.

Referenced by OMK::OutputNT::connect(), OMK::Iii::SimpleConnectorT< Type >::disconnect(), OMK::UnInitialisedAttributeException::insertInStream(), OMK::Output< T >::Output(), OMK::Output< T >::pack(), OMK::Output< T >::packAllValues(), OMK::Input< T >::realConnect(), OMK::Output< T >::set(), OMK::AbstractInput< Type >::setConnectable(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::~IAttributeT().

{
  return _name ;
}

virtual void OMK::KernelAttribute::extract

(

std::istream &

= std::cin

)

[pure virtual]

extract from a stream

Implements OMK::Flowable.

Implemented in OMK::GenericControlParameter< T, AncestorClass >, OMK::Input< T >, OMK::InputAlias< T >, OMK::Output< 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 > >, OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >, OMK::Output< ModelType >, OMK::Output< OMK::Type::SimpleTypeT< bool > >, OMK::Output< OMK::Type::SimpleTypeT< float > >, OMK::Output< OMK::Type::SimpleTypeT< T > >, OMK::Output< OMK::Type::SimpleTypeT< PrmType > >, OMK::Output< PrmType >, OMK::Output< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Output< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::Output< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::InputAlias< T >::extract().

virtual void OMK::KernelAttribute::insertInStream

(

std::ostream &

= std::cout

)

const [pure virtual]

insert in a stream

Implements OMK::Flowable.

Implemented in OMK::GenericControlParameter< T, AncestorClass >, OMK::Input< T >, OMK::InputAlias< T >, OMK::Output< 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 > >, OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >, OMK::Output< ModelType >, OMK::Output< OMK::Type::SimpleTypeT< bool > >, OMK::Output< OMK::Type::SimpleTypeT< float > >, OMK::Output< OMK::Type::SimpleTypeT< T > >, OMK::Output< OMK::Type::SimpleTypeT< PrmType > >, OMK::Output< PrmType >, OMK::Output< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Output< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::Output< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::InputAlias< T >::insertInStream().

virtual void OMK::KernelAttribute::printDebuggingInformation

(

std::ostream &

err

)

const [pure virtual]

print any usefull debugging information for this attribute

Parameters:

err

the output stream on which to print the debugging information

Implemented in OMK::AbstractInput< Type >, OMK::GenericControlParameter< T, AncestorClass >, OMK::Input< T >, OMK::InputAlias< T >, OMK::Output< 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 > >, OMK::InputAlias< OMK::Type::SimpleTypeT< Type > >, OMK::Output< ModelType >, OMK::Output< OMK::Type::SimpleTypeT< bool > >, OMK::Output< OMK::Type::SimpleTypeT< float > >, OMK::Output< OMK::Type::SimpleTypeT< T > >, OMK::Output< OMK::Type::SimpleTypeT< PrmType > >, OMK::Output< PrmType >, OMK::Output< OMK::Type::SimpleTypeT< OMK::Type::Transform > >, OMK::Output< OMK::Type::SimpleTypeT< HBT::PostureData > >, and OMK::Output< OMK::Type::SimpleTypeT< Type > >.

Referenced by OMK::Input< T >::realConnect().

void OMK::KernelAttribute::touch

(

)

const [inline, protected]

Definition at line 70 of file OMKKernelAttribute.h.

References OMK::ObjectHandle::attributeRead().

Referenced by OMK::Output< T >::connectedMyself(), OMK::Output< T >::getDateOfLastExactValue(), OMK::Output< T >::getLastExactValue(), and OMK::Output< T >::localGet().

   {
     ObjectHandle * handle = _owner.getObjectHandle() ;
     if( handle != 0 )
     { // handle could be null during contruction phase of the owner
       handle->attributeRead() ;
     }
   }

---

Member Data Documentation

SimulatedObject& OMK::KernelAttribute::_owner [protected]

a reference to the owner of this attribute

Definition at line 81 of file OMKKernelAttribute.h.

Referenced by OMK::OutputNT::connect(), OMK::Input< T >::connect(), OMK::Input< T >::connectToControlParameter(), OMK::Input< T >::get(), OMK::Output< T >::getDateOfLastExactValue(), OMK::Input< T >::getDateOfLastExactValue(), OMK::Output< T >::getLastExactValue(), OMK::Input< T >::getLastExactValue(), getOwner(), OMK::Output< T >::localGet(), OMK::Output< T >::localInsert(), OMK::Output< T >::printDebuggingInformation(), OMK::InputAlias< T >::printDebuggingInformation(), OMK::Input< T >::printDebuggingInformation(), OMK::Input< T >::realConnect(), OMK::GenericControlParameter< T, AncestorClass >::realSet(), OMK::InputNT::registerMe(), OMK::Output< T >::set(), OMK::GenericControlParameter< T, AncestorClass >::set(), OMK::AbstractInput< Type >::setConnectable(), and OMK::Output< T >::suggest().

const Name OMK::KernelAttribute::_name [protected]

name of the attribute for the owner

Definition at line 85 of file OMKKernelAttribute.h.

Referenced by OMK::Input< T >::get(), OMK::Input< T >::getDateOfLastExactValue(), OMK::Input< T >::getLastExactValue(), getName(), OMK::Output< T >::printDebuggingInformation(), and OMK::InputNT::registerMe().

---