OMK::ConfigurationParameterDescriptor Class Reference

a generic abstract class describing simulated object configuration parameters More...

#include <OMKConfigurationParameterDescriptor.h>

Inheritance diagram for OMK::ConfigurationParameterDescriptor:

[legend]Collaboration diagram for OMK::ConfigurationParameterDescriptor:

[legend]List of all members.

Public Member Functions
	ConfigurationParameterDescriptor ()
	constructor
	ConfigurationParameterDescriptor (const ConfigurationParameterDescriptor &)
	copy constructor
virtual	~ConfigurationParameterDescriptor ()
	destructor
virtual const std::string &	getAssociatedString () const=0
	get a string representation of the configuration parameter
virtual const ConfigurationParameterDescriptor *	getSubDescriptorByName (const std::string &descriptorName) const=0
	get access to a subdescriptor of a certain name
virtual const ConfigurationParameterDescriptor *	getSubDescriptorByPosition (int descriptorPosition) const=0
	get a subdescriptor by it's position in the description
virtual ConfigurationParameterDescriptor *	getSubDescriptorByName (const std::string &descriptorName)=0
	get access to a subdescriptor of a certain name
virtual ConfigurationParameterDescriptor *	getSubDescriptorByPosition (int descriptorPosition)=0
	get a subdescriptor by it's position in the description
virtual int	getNumberOfSubItems () const=0
	get the number of subdescriptors of this descriptor
virtual int	appendSubDescriptor (ConfigurationParameterDescriptor *subDescriptor)=0
	add an unnamed subdescriptor to this descriptor
virtual int	appendSubDescriptorNamed (const std::string &descriptorName, ConfigurationParameterDescriptor *subDescriptor)=0
	add an named subdescriptor to this descriptor
virtual ConfigurationParameterDescriptor *	clone () const=0
	create a clone of this configuration parameter
virtual void	extract (std::istream &=std::cin)=0
	extraction from an input stream
virtual void	insertInStream (std::ostream &=std::cout) const=0
	insertion in an output stream
virtual void	printToStream (std::ostream &out, int offset) const =0
	pretty insertion in an output stream (using an offset value)
virtual void	unpack (IncomingSynchronisationMessage &)=0
	unpack from a synchronisation message
virtual void	pack (OutgoingSynchronisationMessage &) const=0
	pack in a synchronisation message

---

Detailed Description

a generic abstract class describing simulated object configuration parameters

Author:

David Margery

Version:

1.1

• 1.0 -> 1.1 by D. Margery (2002/04/08) : added inheritance from packable

Definition at line 34 of file OMKConfigurationParameterDescriptor.h.

---

Constructor & Destructor Documentation

ConfigurationParameterDescriptor::ConfigurationParameterDescriptor

(

)

constructor

Definition at line 21 of file OMKConfigurationParameterDescriptor.cpp.

{
}

ConfigurationParameterDescriptor::ConfigurationParameterDescriptor

(

const ConfigurationParameterDescriptor &

)

copy constructor

Definition at line 26 of file OMKConfigurationParameterDescriptor.cpp.

{
}

ConfigurationParameterDescriptor::~ConfigurationParameterDescriptor

(

)

[virtual]

destructor

Definition at line 31 of file OMKConfigurationParameterDescriptor.cpp.

{
}

---

Member Function Documentation

virtual const std::string& OMK::ConfigurationParameterDescriptor::getAssociatedString

(

)

const [pure virtual]

get a string representation of the configuration parameter

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::MultipleConfigurationParameter::appendSubDescriptorsOf(), OMK::Controller::Controller(), OMK::ObjectDescriptor::extract(), OMK::ParametersAccessor::getValue(), OMK::ObjectDescriptor::interpretConfigurationParameterAsObjectDescription(), OMK::ObjectDescriptor::interpretSchedulingParameters(), and OMK::PvmController::PvmController().

virtual const ConfigurationParameterDescriptor* OMK::ConfigurationParameterDescriptor::getSubDescriptorByName

(

const std::string &

descriptorName

)

const [pure virtual]

get access to a subdescriptor of a certain name

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::Controller::Controller(), OMK::Iii::IConvertorT< TypeOut, TypeIn >::create(), OMK::ParametersAccessor::getNodeValue(), OMK::Iii::InteractorExtension::InteractorExtension(), OMK::Iii::JointInteractorExtension::loadExtensionParameters(), OMK::Iii::InteractorExtension::loadExtensionParameters(), OMK::Iii::InteractiveExtension::loadExtensionParameters(), OMK::Vis::VisObjectExtension::loadObjectParameters(), and OMK::PvmController::PvmController().

virtual const ConfigurationParameterDescriptor* OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition

(

int

descriptorPosition

)

const [pure virtual]

get a subdescriptor by it's position in the description

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::ParametersAccessor::getValue(), and OMK::Iii::JointInteractorExtension::loadExtensionParameters().

virtual ConfigurationParameterDescriptor* OMK::ConfigurationParameterDescriptor::getSubDescriptorByName

(

const std::string &

descriptorName

)

[pure virtual]

get access to a subdescriptor of a certain name

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

virtual ConfigurationParameterDescriptor* OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition

(

int

descriptorPosition

)

[pure virtual]

get a subdescriptor by it's position in the description

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

virtual int OMK::ConfigurationParameterDescriptor::getNumberOfSubItems

(

)

const [pure virtual]

get the number of subdescriptors of this descriptor

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::ExtensionManager::createExtensionsFromParameters(), OMK::ParametersAccessor::getValue(), OMK::Iii::InteractorExtension::InteractorExtension(), OMK::Iii::JointInteractorExtension::loadExtensionParameters(), OMK::Iii::InteractorExtension::loadExtensionParameters(), OMK::Iii::InteractiveExtension::loadExtensionParameters(), OMK::Inp::InputExtension::loadExtensionParameters(), OMK::Vis::VisObjectExtension::loadObjectParameters(), and OMK::Vis::VisBase::processAddVisualObjectEvent().

virtual int OMK::ConfigurationParameterDescriptor::appendSubDescriptor

(

ConfigurationParameterDescriptor *

subDescriptor

)

[pure virtual]

add an unnamed subdescriptor to this descriptor

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::ParametersAccessor::setValue().

virtual int OMK::ConfigurationParameterDescriptor::appendSubDescriptorNamed	(	const std::string &	descriptorName,
		ConfigurationParameterDescriptor *	subDescriptor
	)			[pure virtual]

add an named subdescriptor to this descriptor

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::ParametersAccessor::set().

virtual ConfigurationParameterDescriptor* OMK::ConfigurationParameterDescriptor::clone

(

)

const [pure virtual]

create a clone of this configuration parameter

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::Type::AddVisualObjectPrm::_copy(), OMK::Inp::AddInputListenerPrm::_copy(), OMK::Type::AddAnimatorPrm::_copy(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::initAnimator(), OMK::Type::AddVisualObjectPrm::innerParametersLoader(), OMK::Inp::AddInputListenerPrm::innerParametersLoader(), OMK::Type::AddAnimatorPrm::innerParametersLoader(), OMK::BasicHumano::loadParameters(), and OMK::ObjectDescriptor::ObjectDescriptor().

virtual void OMK::ConfigurationParameterDescriptor::extract

(

std::istream &

= std::cin

)

[pure virtual]

extraction from an input stream

Implements OMK::Flowable.

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

virtual void OMK::ConfigurationParameterDescriptor::insertInStream

(

std::ostream &

= std::cout

)

const [pure virtual]

insertion in an output stream

Implements OMK::Flowable.

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

virtual void OMK::ConfigurationParameterDescriptor::printToStream	(	std::ostream &	out,
		int	offset
	)			const [pure virtual]

pretty insertion in an output stream (using an offset value)

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

Referenced by OMK::ObjectDescriptor::printToStream().

virtual void OMK::ConfigurationParameterDescriptor::unpack

(

IncomingSynchronisationMessage &

)

[pure virtual]

unpack from a synchronisation message

Reimplemented from OMK::Flowable.

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

virtual void OMK::ConfigurationParameterDescriptor::pack

(

OutgoingSynchronisationMessage &

)

const [pure virtual]

pack in a synchronisation message

Reimplemented from OMK::Flowable.

Implemented in OMK::MultipleConfigurationParameter, and OMK::UniqueConfigurationParameter.

---