OMK::Type::TwoIdsPrm Class Reference
[Interaction objects and ids]

Class TwoIdsPrm generated. More...

#include <OMKControlTakeOverPrm.h>

Inheritance diagram for OMK::Type::TwoIdsPrm:

[legend]Collaboration diagram for OMK::Type::TwoIdsPrm:

[legend]List of all members.

Constructors and destructor.
	TwoIdsPrm ()
	Default constructor of TwoIdsPrm.
	TwoIdsPrm (const TwoIdsPrm &ref)
	Copy constructor of TwoIdsPrm.
	TwoIdsPrm (OMK::Name id, OMK::Name secondId)
	Constructor of TwoIdsPrm with all the parameters.
virtual	~TwoIdsPrm ()
	Destructor of TwoIdsPrm.
TwoIdsPrm &	operator= (const TwoIdsPrm &ref)
	Copy operator.
Public Attributes
Public members
OMK::Name	_id
	This member holds the id value of TwoIdsPrm.
OMK::Name	_secondId
	This member holds the secondId value of TwoIdsPrm.
Protected Member Functions
void	_copy (const TwoIdsPrm &q)
	Copy.
Friends
class	OMK::ParametersAccessor
	Friend parametor accessor.
Friend compare operators.
OMKIII_API bool	operator!= (const TwoIdsPrm &t0, const TwoIdsPrm &t1)
	Inequality operator for TwoIdsPrm.
OMKIII_API bool	operator== (const TwoIdsPrm &t0, const TwoIdsPrm &t1)
	Equality operator for TwoIdsPrm.
Friend stream operators.
std::ostream &	operator<< (std::ostream &out, const TwoIdsPrm &t)
	stream operator for TwoIdsPrm.
std::istream &	operator>> (std::istream &in, TwoIdsPrm &t)
	stream operator for TwoIdsPrm.
OMK::OutgoingSynchronisationMessage &	operator<< (OMK::OutgoingSynchronisationMessage &out, const TwoIdsPrm &t)
	stream operator for TwoIdsPrm.
OMK::IncomingSynchronisationMessage &	operator>> (OMK::IncomingSynchronisationMessage &in, TwoIdsPrm &t)
	stream operator for TwoIdsPrm.

---

Detailed Description

Class TwoIdsPrm generated.

Date:

generated the 2008-05-19 at 16:59:47

Description

This class is generated. Use it by derivation to add the necessary methods.

Configuration parameters

This structure can be read in the configuration with the OMK::ParametersAccessor. There is two ways to define the configuration parameters in the configuration file, the first is hierarchical one, the second is the vector way. The first one is more obvious but more verbose ; optional parameters don't need to be defined. The second one is less obvious but more compact ; it is easier to use in vectors.

Optional parameters

The following parameters are optional and if one is missing in the configuration parameters calling OMK::ParametersAccessor::get always returns true and never display message.

• Id a OMK::Name stored in _id.
• SecondId a OMK::Name stored in _secondId.

  Configuration example

  The following sample of configuration parameters shows the two ways to define this structure.

  myObject
  {
    Class ObjectWhichUsesTwoIdsPrm
    ... // Scheduling partameters
    UserParams
    {
      First // Hierarchical
      {
        // Optional parameters
       Id "id"
       SecondId "id"
      }
      Second [ "id" "id" ]
      ... //other object parameters
    }
    ... // Extensions partameters
  }

To use these two configuration parameters use the following codes:

  OMK::Type::TwoIdsPrm _first ;
  OMK::Type::TwoIdsPrm _second ;
  OMK::ParametersAccessor::get( node, "First", _first ) ;
  OMK::ParametersAccessor::get( node, "Second", _second ) ;

Definition at line 328 of file OMKControlTakeOverPrm.h.

---

Constructor & Destructor Documentation

TwoIdsPrm::TwoIdsPrm

(

)

Default constructor of TwoIdsPrm.

Definition at line 191 of file OMKControlTakeOverPrm.cpp.

: _id( OMK::Name() ),
  _secondId( OMK::Name() )
{
}

TwoIdsPrm::TwoIdsPrm

(

const TwoIdsPrm &

ref

)

Copy constructor of TwoIdsPrm.

Definition at line 199 of file OMKControlTakeOverPrm.cpp.

References _copy().

{
  _copy( ref ) ;
}

TwoIdsPrm::TwoIdsPrm	(	OMK::Name	id,
		OMK::Name	secondId
	)

Constructor of TwoIdsPrm with all the parameters.

Definition at line 206 of file OMKControlTakeOverPrm.cpp.

: _id( id ),
  _secondId( secondId )
{
}

TwoIdsPrm::~TwoIdsPrm

(

)

[virtual]

Destructor of TwoIdsPrm.

Definition at line 215 of file OMKControlTakeOverPrm.cpp.

{
}

---

Member Function Documentation

TwoIdsPrm & TwoIdsPrm::operator=

(

const TwoIdsPrm &

ref

)

Copy operator.

Definition at line 221 of file OMKControlTakeOverPrm.cpp.

References _copy().

{
  if ( this != &ref )
  {
    _copy( ref ) ;
  }
  return *this ;
}

void TwoIdsPrm::_copy

(

const TwoIdsPrm &

q

)

[protected]

Copy.

Definition at line 232 of file OMKControlTakeOverPrm.cpp.

References _id, and _secondId.

Referenced by OMK::Type::ControlTakeOverPrm::_copy(), operator=(), and TwoIdsPrm().

{
  _id = ref._id ; 
  _secondId = ref._secondId ; 
}

---

Friends And Related Function Documentation

friend class OMK::ParametersAccessor [friend]

Friend parametor accessor.

Reimplemented in OMK::Type::ControlTakeOverPrm.

Definition at line 367 of file OMKControlTakeOverPrm.h.

OMKIII_API bool operator!=	(	const TwoIdsPrm &	t0,
		const TwoIdsPrm &	t1
	)			[friend]

Inequality operator for TwoIdsPrm.

Definition at line 245 of file OMKControlTakeOverPrm.cpp.

{
  return t0._id != t1._id
      || t0._secondId != t1._secondId ;
}

OMKIII_API bool operator==	(	const TwoIdsPrm &	t0,
		const TwoIdsPrm &	t1
	)			[friend]

Equality operator for TwoIdsPrm.

Definition at line 362 of file OMKControlTakeOverPrm.h.

    { return !( t0 != t1 ) ; }

std::ostream& operator<<	(	std::ostream &	out,
		const TwoIdsPrm &	t
	)			[friend]

stream operator for TwoIdsPrm.

Use by SimpleTypeT::insertInStream.

Definition at line 257 of file OMKControlTakeOverPrm.cpp.

{
  out << t._id << " "
      << t._secondId << " "
      << " " ;
  return out ;
}

std::istream& operator>>	(	std::istream &	in,
		TwoIdsPrm &	t
	)			[friend]

stream operator for TwoIdsPrm.

Use by SimpleTypeT::extract.

Definition at line 267 of file OMKControlTakeOverPrm.cpp.

{
  in >> t._id
     >> t._secondId ;
  return in ;
}

OMK::OutgoingSynchronisationMessage& operator<<	(	OMK::OutgoingSynchronisationMessage &	out,
		const TwoIdsPrm &	t
	)			[friend]

stream operator for TwoIdsPrm.

Use by SimpleTypeT::pack.

Definition at line 276 of file OMKControlTakeOverPrm.cpp.

{
  out << t._id
      << t._secondId ;
  return out ;
}

OMK::IncomingSynchronisationMessage& operator>>	(	OMK::IncomingSynchronisationMessage &	in,
		TwoIdsPrm &	t
	)			[friend]

stream operator for TwoIdsPrm.

Use by SimpleTypeT::unpack.

Definition at line 285 of file OMKControlTakeOverPrm.cpp.

{
  in >> t._id
     >> t._secondId ;
  return in ;
}

---

Member Data Documentation

OMK::Name OMK::Type::TwoIdsPrm::_id

This member holds the id value of TwoIdsPrm.

Definition at line 350 of file OMKControlTakeOverPrm.h.

Referenced by _copy(), OMK::Type::operator!=(), operator<<(), and operator>>().

OMK::Name OMK::Type::TwoIdsPrm::_secondId

This member holds the secondId value of TwoIdsPrm.

Definition at line 352 of file OMKControlTakeOverPrm.h.

Referenced by _copy(), OMK::Type::operator!=(), operator<<(), and operator>>().

---