Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

PsUniqueConfigurationParameter Class Reference

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

#include <PsUniqueConfigurationParameter.h>

Inheritance diagram for PsUniqueConfigurationParameter:

Inheritance graph
[legend]
Collaboration diagram for PsUniqueConfigurationParameter:

Collaboration graph
[legend]
List of all members.

Public Methods

 PsUniqueConfigurationParameter (const PsUniqueConfigurationParameter &uniqueConfigParameter)
 copy constructor

 PsUniqueConfigurationParameter (const string &uniqueConfigParameter)
 contruct with a value

virtual ~PsUniqueConfigurationParameter ()
 destructor

virtual const string & getAssociatedString () const
 get the value of the descriptor

virtual const PsConfigurationParameterDescriptor * getSubDescriptorByName (const string &descriptorName) const
 returns NULL

virtual const PsConfigurationParameterDescriptor * getSubDescriptorByPosition (int descriptorPosition) const
 returns NULL

virtual PsConfigurationParameterDescriptor * getSubDescriptorByName (const string &descriptorName)
 returns NULL

virtual PsConfigurationParameterDescriptor * getSubDescriptorByPosition (int descriptorPosition)
 returns NULL

virtual int getNumberOfSubItems () const
 returns -1

virtual int appendSubDescriptor (PsConfigurationParameterDescriptor *subDescriptor)
 returns -1

virtual int appendSubDescriptorNamed (const string &descriptorName, PsConfigurationParameterDescriptor *subDescriptor)
 returns -1

virtual void changeConfigurationParameter (const string &)
 change the configuration parameter

virtual PsConfigurationParameterDescriptor * clone () const
 create a clone of this configuration parameter

virtual void extract (istream &=cin)
 extraction from an input stream

virtual void insertInStream (ostream &=cout) const
 insertion in an output stream

virtual void printToStream (ostream &out, int offset) const
 pretty insertion in an output stream (using an offset value)

virtual void unpack (PsIncomingSynchronisationMessage &)
 unpack from a synchronisation message

virtual void pack (PsOutgoingSynchronisationMessage &) const
 pack in a synchronisation message


Protected Attributes

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 27 of file PsUniqueConfigurationParameter.h.

Constructor & Destructor Documentation

PsUniqueConfigurationParameter::PsUniqueConfigurationParameter (  const PsUniqueConfigurationParameter &    uniqueConfigParameter ) 
 

copy constructor

Definition at line 29 of file PsUniqueConfigurationParameter.cxx.

Referenced by clone(). 

00029                                                                                                                                     :
00030    PsConfigurationParameterDescriptor ( uniqueConfigurationParameter ) ,
00031    _uniqueConfigurationParameter ( uniqueConfigurationParameter._uniqueConfigurationParameter )
00032 {
00033 
00034 }

PsUniqueConfigurationParameter::PsUniqueConfigurationParameter (  const string &    uniqueConfigParameter ) 
 

contruct with a value

Definition at line 20 of file PsUniqueConfigurationParameter.cxx. 

00020                                                                                                             :
00021    PsConfigurationParameterDescriptor () ,
00022    _uniqueConfigurationParameter ( uniqueConfigurationParameter )
00023 {
00024 
00025 }

PsUniqueConfigurationParameter::~PsUniqueConfigurationParameter (    )  [virtual]
 

destructor

Definition at line 41 of file PsUniqueConfigurationParameter.cxx. 

00042 {
00043 
00044 }

Member Function Documentation

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

returns -1

Implements PsConfigurationParameterDescriptor.

Definition at line 97 of file PsUniqueConfigurationParameter.cxx. 

00098 {
00099    return -1 ;
00100 }

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

returns -1

Implements PsConfigurationParameterDescriptor.

Definition at line 104 of file PsUniqueConfigurationParameter.cxx. 

00105 {
00106    return -1 ;
00107 }

void PsUniqueConfigurationParameter::changeConfigurationParameter (  const string &    )  [virtual]
 

change the configuration parameter

Definition at line 48 of file PsUniqueConfigurationParameter.cxx.

References _uniqueConfigurationParameter.

Referenced by PsObjectDescriptor::setProcess(). 

00049 {
00050    _uniqueConfigurationParameter = newParameter ;
00051 }

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

create a clone of this configuration parameter

Implements PsConfigurationParameterDescriptor.

Definition at line 36 of file PsUniqueConfigurationParameter.cxx.

References PsUniqueConfigurationParameter(). 

00037 {
00038    return new PsUniqueConfigurationParameter( *this ) ;
00039 }

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

extraction from an input stream

Implements PsConfigurationParameterDescriptor.

Definition at line 133 of file PsUniqueConfigurationParameter.cxx.

References _uniqueConfigurationParameter. 

00134 {
00135    in >> _uniqueConfigurationParameter ;
00136 }

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

get the value of the descriptor

Implements PsConfigurationParameterDescriptor.

Definition at line 55 of file PsUniqueConfigurationParameter.cxx.

References _uniqueConfigurationParameter. 

00056 {
00057    return _uniqueConfigurationParameter ;
00058 }

int PsUniqueConfigurationParameter::getNumberOfSubItems (    )  const [virtual]
 

returns -1

Implements PsConfigurationParameterDescriptor.

Definition at line 90 of file PsUniqueConfigurationParameter.cxx. 

00091 {
00092    return 1 ;
00093 }

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

returns NULL

Implements PsConfigurationParameterDescriptor.

Definition at line 76 of file PsUniqueConfigurationParameter.cxx. 

00077 {
00078    return NULL ;
00079 }

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

returns NULL

Implements PsConfigurationParameterDescriptor.

Definition at line 62 of file PsUniqueConfigurationParameter.cxx. 

00063 {
00064    return NULL ;
00065 }

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

returns NULL

Implements PsConfigurationParameterDescriptor.

Definition at line 83 of file PsUniqueConfigurationParameter.cxx. 

00084 {
00085    return NULL ;
00086 }

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

returns NULL

Implements PsConfigurationParameterDescriptor.

Definition at line 69 of file PsUniqueConfigurationParameter.cxx. 

00070 {
00071    return NULL ;
00072 }

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

insertion in an output stream

Implements PsConfigurationParameterDescriptor.

Definition at line 128 of file PsUniqueConfigurationParameter.cxx.

References _uniqueConfigurationParameter. 

00129 {
00130    out<<_uniqueConfigurationParameter<<" ";
00131 }

void PsUniqueConfigurationParameter::pack (  PsOutgoingSynchronisationMessage &    )  const [virtual]
 

pack in a synchronisation message

Implements PsConfigurationParameterDescriptor.

Definition at line 111 of file PsUniqueConfigurationParameter.cxx. 

00112 {
00113    //out<<_uniqueConfigurationParameter.c_str() ;
00114    assert ( false ) ;
00115 }

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

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

Implements PsConfigurationParameterDescriptor.

Definition at line 123 of file PsUniqueConfigurationParameter.cxx.

References _uniqueConfigurationParameter. 

00124 {
00125    out <<_uniqueConfigurationParameter;
00126 }

void PsUniqueConfigurationParameter::unpack (  PsIncomingSynchronisationMessage &    )  [virtual]
 

unpack from a synchronisation message

Implements PsConfigurationParameterDescriptor.

Definition at line 117 of file PsUniqueConfigurationParameter.cxx. 

00118 {
00119    //in>>_uniqueConfigurationParameter ;
00120    assert ( false ) ;
00121 }

Member Data Documentation

string PsUniqueConfigurationParameter::_uniqueConfigurationParameter [protected]
 

the configuration parameter

Definition at line 90 of file PsUniqueConfigurationParameter.h.

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

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

Documentation generated on Mon Nov 25 15:26:35 2002

Generated with doxygen 1.2.12 by Dimitri van Heesch ,   1997-2001