OMK::UniqueConfigurationParameter Class Reference

class to describe one unique parameter, represented as a string More...

#include <OMKUniqueConfigurationParameter.h>

Inheritance diagram for OMK::UniqueConfigurationParameter:

[legend]Collaboration diagram for OMK::UniqueConfigurationParameter:


Public Member Functions
	UniqueConfigurationParameter (const UniqueConfigurationParameter &uniqueConfigParameter)
	copy constructor
	UniqueConfigurationParameter (const std::string &uniqueConfigParameter)
	contruct with a value
virtual	~UniqueConfigurationParameter ()
	destructor
virtual const std::string &	getAssociatedString () const
	get the value of the descriptor
virtual const ConfigurationParameterDescriptor *	getSubDescriptorByName (const std::string &descriptorName) const
	returns NULL
virtual const ConfigurationParameterDescriptor *	getSubDescriptorByPosition (int descriptorPosition) const
	returns NULL
virtual ConfigurationParameterDescriptor *	getSubDescriptorByName (const std::string &descriptorName)
	returns NULL
virtual ConfigurationParameterDescriptor *	getSubDescriptorByPosition (int descriptorPosition)
	returns NULL
virtual int	getNumberOfSubItems () const
	returns -1
virtual int	appendSubDescriptor (ConfigurationParameterDescriptor *subDescriptor)
	returns -1
virtual int	appendSubDescriptorNamed (const std::string &descriptorName, ConfigurationParameterDescriptor *subDescriptor)
	returns -1
virtual void	changeConfigurationParameter (const std::string &)
	change the configuration parameter
virtual ConfigurationParameterDescriptor *	clone () const
	create a clone of this configuration parameter
virtual void	extract (std::istream &=std::cin)
	extraction from an input stream
virtual void	insertInStream (std::ostream &=std::cout) const
	insertion in an output stream
virtual void	printToStream (std::ostream &out, int offset) const
	pretty insertion in an output stream (using an offset value)
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack from a synchronisation message
virtual void	pack (OutgoingSynchronisationMessage &) const
	pack in a synchronisation message
Protected Attributes
std::string	_uniqueConfigurationParameter
	the configuration parameter

Detailed Description

class to describe one unique parameter, represented as a string

Author:: David Margery (last revision by $author$)

Version:: 1.0

Definition at line 30 of file OMKUniqueConfigurationParameter.h.

Constructor & Destructor Documentation

UniqueConfigurationParameter::UniqueConfigurationParameter ( const UniqueConfigurationParameter & uniqueConfigParameter )

copy constructor

Definition at line 33 of file OMKUniqueConfigurationParameter.cpp.

Referenced by clone().

00033                                                                                                                               :
00034    ConfigurationParameterDescriptor ( uniqueConfigurationParameter ) ,
00035    _uniqueConfigurationParameter ( uniqueConfigurationParameter._uniqueConfigurationParameter )
00036 {
00037 
00038 }

UniqueConfigurationParameter::UniqueConfigurationParameter ( const std::string & uniqueConfigParameter )

contruct with a value

Definition at line 24 of file OMKUniqueConfigurationParameter.cpp.

00024                                                                                                         :
00025    ConfigurationParameterDescriptor () ,
00026    _uniqueConfigurationParameter ( uniqueConfigurationParameter )
00027 {
00028 
00029 }

UniqueConfigurationParameter::~UniqueConfigurationParameter ( ) [virtual]

destructor

Definition at line 45 of file OMKUniqueConfigurationParameter.cpp.

00046 {
00047 
00048 }

Member Function Documentation

const string & UniqueConfigurationParameter::getAssociatedString ( ) const [virtual]

get the value of the descriptor

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 59 of file OMKUniqueConfigurationParameter.cpp.

References _uniqueConfigurationParameter.

00060 {
00061    return _uniqueConfigurationParameter ;
00062 }

const ConfigurationParameterDescriptor * UniqueConfigurationParameter::getSubDescriptorByName ( const std::string & descriptorName ) const [virtual]

returns NULL

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 66 of file OMKUniqueConfigurationParameter.cpp.

00067 {
00068    return NULL ;
00069 }

const ConfigurationParameterDescriptor * UniqueConfigurationParameter::getSubDescriptorByPosition ( int descriptorPosition ) const [virtual]

returns NULL

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 73 of file OMKUniqueConfigurationParameter.cpp.

00074 {
00075    return NULL ;
00076 }

ConfigurationParameterDescriptor * UniqueConfigurationParameter::getSubDescriptorByName ( const std::string & descriptorName ) [virtual]

returns NULL

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 80 of file OMKUniqueConfigurationParameter.cpp.

00081 {
00082    return NULL ;
00083 }

ConfigurationParameterDescriptor * UniqueConfigurationParameter::getSubDescriptorByPosition ( int descriptorPosition ) [virtual]

returns NULL

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 87 of file OMKUniqueConfigurationParameter.cpp.

00088 {
00089    return NULL ;
00090 }

int UniqueConfigurationParameter::getNumberOfSubItems ( ) const [virtual]

returns -1

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 94 of file OMKUniqueConfigurationParameter.cpp.

00095 {
00096    return 1 ;
00097 }

int UniqueConfigurationParameter::appendSubDescriptor ( ConfigurationParameterDescriptor * subDescriptor ) [virtual]

returns -1

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 101 of file OMKUniqueConfigurationParameter.cpp.

00102 {
00103    return -1 ;
00104 }

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

returns -1

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 108 of file OMKUniqueConfigurationParameter.cpp.

00109 {
00110    return -1 ;
00111 }

void UniqueConfigurationParameter::changeConfigurationParameter ( const std::string & ) [virtual]

change the configuration parameter

Definition at line 52 of file OMKUniqueConfigurationParameter.cpp.

References _uniqueConfigurationParameter.

Referenced by OMK::ObjectDescriptor::setDistribution(), OMK::ObjectDescriptor::setFrequency(), and OMK::ObjectDescriptor::setProcess().

00053 {
00054    _uniqueConfigurationParameter = newParameter ;
00055 }

ConfigurationParameterDescriptor * UniqueConfigurationParameter::clone ( ) const [virtual]

create a clone of this configuration parameter

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 40 of file OMKUniqueConfigurationParameter.cpp.

References UniqueConfigurationParameter().

00041 {
00042    return new UniqueConfigurationParameter( *this ) ;
00043 }

void UniqueConfigurationParameter::extract ( std::istream & = std::cin ) [virtual]

extraction from an input stream

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 137 of file OMKUniqueConfigurationParameter.cpp.

References _uniqueConfigurationParameter.

00138 {
00139    in >> _uniqueConfigurationParameter ;
00140 }

void UniqueConfigurationParameter::insertInStream ( std::ostream & = std::cout ) const [virtual]

insertion in an output stream

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 132 of file OMKUniqueConfigurationParameter.cpp.

References _uniqueConfigurationParameter.

00133 {
00134    out<<_uniqueConfigurationParameter<<" ";
00135 }

void UniqueConfigurationParameter::printToStream	(	std::ostream &	out,
		int	offset
	)			const `[virtual]`

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

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 127 of file OMKUniqueConfigurationParameter.cpp.

References _uniqueConfigurationParameter.

00128 {
00129    out <<"\"" << _uniqueConfigurationParameter <<"\"";
00130 }

void UniqueConfigurationParameter::unpack ( IncomingSynchronisationMessage & ) [virtual]

unpack from a synchronisation message

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 121 of file OMKUniqueConfigurationParameter.cpp.

References OMASSERT.

00122 {
00123    //in>>_uniqueConfigurationParameter ;
00124    OMASSERT ( false ) ;
00125 }

void UniqueConfigurationParameter::pack ( OutgoingSynchronisationMessage & ) const [virtual]

pack in a synchronisation message

Implements OMK::ConfigurationParameterDescriptor.

Definition at line 115 of file OMKUniqueConfigurationParameter.cpp.

References OMASSERT.

00116 {
00117    //out<<_uniqueConfigurationParameter.c_str() ;
00118    OMASSERT( false ) ;
00119 }

Member Data Documentation

std::string OMK::UniqueConfigurationParameter::_uniqueConfigurationParameter [protected]

the configuration parameter

Definition at line 93 of file OMKUniqueConfigurationParameter.h.

Referenced by changeConfigurationParameter(), extract(), getAssociatedString(), insertInStream(), and printToStream().

Documentation generated on Mon Jun 9 11:46:03 2008
Generated with doxygen by Dimitri van Heesch , 1997-2007

OMK::UniqueConfigurationParameter Class Reference

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation