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

Class ControlTakeOverPrm generated. More...

#include <OMKControlTakeOverPrm.h>

Inheritance diagram for OMK::Type::ControlTakeOverPrm:

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

[legend]List of all members.

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

---

Detailed Description

Class ControlTakeOverPrm generated.

Date:

generated the 2008-05-19 at 17:38:18

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.

• AccessLevels a map of int indexed by OMK::Name stored in _accessLevels.

  Configuration example

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

  myObject
  {
    Class ObjectWhichUsesControlTakeOverPrm
    ... // Scheduling partameters
    UserParams
    {
      First // Hierarchical
      {
        // Optional parameters
       Id "id"
       SecondId "id"
       AccessGroup [ [ "string" <int> ] ... ]
      }
      Second [ "id" "id" [ [ "string" <int> ] ... ] ]
      ... //other object parameters
    }
    ... // Extensions partameters
  }

To use these two configuration parameters use the following codes:

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

Definition at line 507 of file OMKControlTakeOverPrm.h.

---

Constructor & Destructor Documentation

ControlTakeOverPrm::ControlTakeOverPrm

(

)

Default constructor of ControlTakeOverPrm.

Definition at line 345 of file OMKControlTakeOverPrm.cpp.

: OMK::Type::TwoIdsPrm(),
  _accessGroup()
{
}

ControlTakeOverPrm::ControlTakeOverPrm

(

const ControlTakeOverPrm &

ref

)

Copy constructor of ControlTakeOverPrm.

Definition at line 353 of file OMKControlTakeOverPrm.cpp.

References _copy().

: OMK::Type::TwoIdsPrm(),
  _accessGroup()
{
  _copy( ref ) ;
}

ControlTakeOverPrm::ControlTakeOverPrm	(	const Name &	id,
		const Name &	secondId
	)

Constructor of ControlTakeOverPrm with all the parameters.

Definition at line 362 of file OMKControlTakeOverPrm.cpp.

: OMK::Type::TwoIdsPrm( id, secondId ),
  _accessGroup()
{
}

ControlTakeOverPrm::ControlTakeOverPrm	(	const Name &	id,
		const Name &	secondId,
		const AccessGroupLevel &	accessGroup
	)

Constructor of ControlTakeOverPrm with all the parameters.

Definition at line 370 of file OMKControlTakeOverPrm.cpp.

: OMK::Type::TwoIdsPrm( id, secondId ),
  _accessGroup( accessGroup )
{
}

ControlTakeOverPrm::~ControlTakeOverPrm

(

)

[virtual]

Destructor of ControlTakeOverPrm.

Definition at line 379 of file OMKControlTakeOverPrm.cpp.

{
}

---

Member Function Documentation

ControlTakeOverPrm & ControlTakeOverPrm::operator=

(

const ControlTakeOverPrm &

ref

)

Copy operator.

Definition at line 385 of file OMKControlTakeOverPrm.cpp.

References _copy().

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

void ControlTakeOverPrm::_copy

(

const ControlTakeOverPrm &

q

)

[protected]

Copy.

Definition at line 396 of file OMKControlTakeOverPrm.cpp.

References _accessGroup, and OMK::Type::TwoIdsPrm::_copy().

Referenced by ControlTakeOverPrm(), and operator=().

{
  OMK::Type::TwoIdsPrm::_copy( ref ) ;
  _accessGroup = ref._accessGroup ; 
}

---

Friends And Related Function Documentation

friend class OMK::ParametersAccessor [friend]

Friend parametor accessor.

Reimplemented from OMK::Type::TwoIdsPrm.

Definition at line 548 of file OMKControlTakeOverPrm.h.

OMKIII_API bool operator!=	(	const ControlTakeOverPrm &	c0,
		const ControlTakeOverPrm &	c1
	)			[friend]

Inequality operator for ControlTakeOverPrm.

Definition at line 409 of file OMKControlTakeOverPrm.cpp.

{
  return (OMK::Type::TwoIdsPrm)c0 != (OMK::Type::TwoIdsPrm)c1
      || c0._accessGroup != c1._accessGroup ;
}

OMKIII_API bool operator==	(	const ControlTakeOverPrm &	c0,
		const ControlTakeOverPrm &	c1
	)			[friend]

Equality operator for ControlTakeOverPrm.

Definition at line 543 of file OMKControlTakeOverPrm.h.

    { return !( c0 != c1 ) ; }

std::ostream& operator<<	(	std::ostream &	out,
		const ControlTakeOverPrm &	c
	)			[friend]

stream operator for ControlTakeOverPrm.

Use by SimpleTypeT::insertInStream.

Definition at line 421 of file OMKControlTakeOverPrm.cpp.

{
  out << (OMK::Type::TwoIdsPrm)c
      << c._accessGroup << " "
      << " " ;
  return out ;
}

std::istream& operator>>	(	std::istream &	in,
		ControlTakeOverPrm &	c
	)			[friend]

stream operator for ControlTakeOverPrm.

Use by SimpleTypeT::extract.

Definition at line 431 of file OMKControlTakeOverPrm.cpp.

{
  in >> (OMK::Type::TwoIdsPrm&)c
     >> c._accessGroup ;
  return in ;
}

OMK::OutgoingSynchronisationMessage& operator<<	(	OMK::OutgoingSynchronisationMessage &	out,
		const ControlTakeOverPrm &	c
	)			[friend]

stream operator for ControlTakeOverPrm.

Use by SimpleTypeT::pack.

Definition at line 440 of file OMKControlTakeOverPrm.cpp.

{
  out << (OMK::Type::TwoIdsPrm)c
      << c._accessGroup ;
  return out ;
}

OMK::IncomingSynchronisationMessage& operator>>	(	OMK::IncomingSynchronisationMessage &	in,
		ControlTakeOverPrm &	c
	)			[friend]

stream operator for ControlTakeOverPrm.

Use by SimpleTypeT::unpack.

Definition at line 449 of file OMKControlTakeOverPrm.cpp.

{
  in >> (OMK::Type::TwoIdsPrm&)c
     >> c._accessGroup ;
  return in ;
}

---

Member Data Documentation

AccessGroupLevel OMK::Type::ControlTakeOverPrm::_accessGroup

This member holds the accessGroup values of ControlTakeOverPrm.

Definition at line 533 of file OMKControlTakeOverPrm.h.

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

---