---

PsConfigurationParameterDescriptor Class Reference

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

#include <PsConfigurationParameterDescriptor.h>

Inheritance diagram for PsConfigurationParameterDescriptor:

[legend]Collaboration diagram for PsConfigurationParameterDescriptor:

[legend]List of all members.

Public Methods
	PsConfigurationParameterDescriptor ()
	constructor
	PsConfigurationParameterDescriptor (const PsConfigurationParameterDescriptor &)
	copy constructor
virtual	~PsConfigurationParameterDescriptor ()
	destructor
virtual const string &	getAssociatedString () const=0
	get a string representation of the configuration parameter
virtual const PsConfigurationParameterDescriptor *	getSubDescriptorByName (const string &descriptorName) const=0
	get access to a subdescriptor of a certain name
virtual const PsConfigurationParameterDescriptor *	getSubDescriptorByPosition (int descriptorPosition) const=0
	get a subdescriptor by it's position in the description
virtual PsConfigurationParameterDescriptor *	getSubDescriptorByName (const string &descriptorName)=0
	get access to a subdescriptor of a certain name
virtual PsConfigurationParameterDescriptor *	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 (PsConfigurationParameterDescriptor *subDescriptor)=0
	add an unnamed subdescriptor to this descriptor
virtual int	appendSubDescriptorNamed (const string &descriptorName, PsConfigurationParameterDescriptor *subDescriptor)=0
	add an named subdescriptor to this descriptor
virtual PsConfigurationParameterDescriptor *	clone () const=0
	create a clone of this configuration parameter
virtual void	extract (istream &=cin)=0
	extraction from an input stream
virtual void	insertInStream (ostream &=cout) const=0
	insertion in an output stream
virtual void	printToStream (ostream &out, int offset) const=0
	pretty insertion in an output stream (using an offset value)
virtual void	unpack (PsIncomingSynchronisationMessage &)=0
	unpack from a synchronisation message
virtual void	pack (PsOutgoingSynchronisationMessage &) 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 PsConfigurationParameterDescriptor.h.

---

Constructor & Destructor Documentation

PsConfigurationParameterDescriptor::PsConfigurationParameterDescriptor (    )

constructor Definition at line 20 of file PsConfigurationParameterDescriptor.cxx. { }

PsConfigurationParameterDescriptor::PsConfigurationParameterDescriptor (  const PsConfigurationParameterDescriptor &    )

copy constructor Definition at line 25 of file PsConfigurationParameterDescriptor.cxx. { }

PsConfigurationParameterDescriptor::~PsConfigurationParameterDescriptor (    )  [virtual]

destructor Definition at line 30 of file PsConfigurationParameterDescriptor.cxx. { }

---

Member Function Documentation

virtual int PsConfigurationParameterDescriptor::appendSubDescriptor (  PsConfigurationParameterDescriptor *    subDescriptor )  [pure virtual]

add an unnamed subdescriptor to this descriptor Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

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

add an named subdescriptor to this descriptor Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual PsConfigurationParameterDescriptor* PsConfigurationParameterDescriptor::clone (    )  const [pure virtual]

create a clone of this configuration parameter Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter. Referenced by PsObjectDescriptor::PsObjectDescriptor().

virtual void PsConfigurationParameterDescriptor::extract (  istream &    = cin )  [pure virtual]

extraction from an input stream Implements PsFlowable. Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual const string& PsConfigurationParameterDescriptor::getAssociatedString (    )  const [pure virtual]

get a string representation of the configuration parameter Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter. Referenced by PsMultipleConfigurationParameter::appendSubDescriptorsOf(), PsObjectDescriptor::extract(), PsObjectDescriptor::interpretConfigurationParameterAsObjectDescription(), PsObjectDescriptor::interpretSchedulingParameters(), PsBenchController< BenchedController >::PsBenchController(), PsMultiThreadedController::PsMultiThreadedController(), PsMultiThreadedPvmController::PsMultiThreadedPvmController(), and PsTimerController< ControleurAncetre >::PsTimerController().

virtual int PsConfigurationParameterDescriptor::getNumberOfSubItems (    )  const [pure virtual]

get the number of subdescriptors of this descriptor Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual PsConfigurationParameterDescriptor* PsConfigurationParameterDescriptor::getSubDescriptorByName (  const string &    descriptorName )  [pure virtual]

get access to a subdescriptor of a certain name Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual const PsConfigurationParameterDescriptor* PsConfigurationParameterDescriptor::getSubDescriptorByName (  const string &    descriptorName )  const [pure virtual]

get access to a subdescriptor of a certain name Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter. Referenced by PsBenchController< BenchedController >::PsBenchController(), and PsTimerController< ControleurAncetre >::PsTimerController().

virtual PsConfigurationParameterDescriptor* PsConfigurationParameterDescriptor::getSubDescriptorByPosition (  int    descriptorPosition )  [pure virtual]

get a subdescriptor by it's position in the description Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual const PsConfigurationParameterDescriptor* PsConfigurationParameterDescriptor::getSubDescriptorByPosition (  int    descriptorPosition )  const [pure virtual]

get a subdescriptor by it's position in the description Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual void PsConfigurationParameterDescriptor::insertInStream (  ostream &    = cout )  const [pure virtual]

insertion in an output stream Implements PsFlowable. Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

virtual void PsConfigurationParameterDescriptor::pack (  PsOutgoingSynchronisationMessage &    )  const [pure virtual]

pack in a synchronisation message Reimplemented from PsFlowable. Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

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

pretty insertion in an output stream (using an offset value) Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter. Referenced by PsObjectDescriptor::printToStream().

virtual void PsConfigurationParameterDescriptor::unpack (  PsIncomingSynchronisationMessage &    )  [pure virtual]

unpack from a synchronisation message Reimplemented from PsFlowable. Implemented in PsMultipleConfigurationParameter, and PsUniqueConfigurationParameter.

---

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

• PsConfigurationParameterDescriptor.h
• PsConfigurationParameterDescriptor.cxx

---