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

Class AccessGroup generated. More...

#include <OMKControlTakeOverPrm.h>

Inheritance diagram for OMK::Type::AccessGroup:

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

[legend]List of all members.

Constructors and destructor.
	AccessGroup ()
	Default constructor of AccessGroup.
	AccessGroup (const AccessGroup &ref)
	Copy constructor of AccessGroup.
	AccessGroup (const Name &groupName, AccessLevel level)
	Constructor of AccessGroup with all the parameters.
virtual	~AccessGroup ()
	Destructor of AccessGroup.
AccessGroup &	operator= (const AccessGroup &ref)
	Copy operator.
Public Attributes
Public members
Name	_groupName
	This member holds the groupName value of AccessGroup.
AccessLevel	_level
	This member holds the level value of AccessGroup.
Protected Member Functions
void	_copy (const AccessGroup &q)
	Copy.
Friends
class	OMK::ParametersAccessor
	Friend parametor accessor.
Friend compare operators.
OMKIII_API bool	operator!= (const AccessGroup &a0, const AccessGroup &a1)
	Inequality operator for AccessGroup.
OMKIII_API bool	operator== (const AccessGroup &a0, const AccessGroup &a1)
	Equality operator for AccessGroup.
Friend stream operators.
std::ostream &	operator<< (std::ostream &out, const AccessGroup &a)
	stream operator for AccessGroup.
std::istream &	operator>> (std::istream &in, AccessGroup &a)
	stream operator for AccessGroup.
OMK::OutgoingSynchronisationMessage &	operator<< (OMK::OutgoingSynchronisationMessage &out, const AccessGroup &a)
	stream operator for AccessGroup.
OMK::IncomingSynchronisationMessage &	operator>> (OMK::IncomingSynchronisationMessage &in, AccessGroup &a)
	stream operator for AccessGroup.

---

Detailed Description

Class AccessGroup 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.

• GroupName a std::string stored in _groupName.
• Level a int stored in _level.

  Configuration example

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

  myObject
  {
    Class ObjectWhichUsesAccessGroup
    ... // Scheduling partameters
    UserParams
    {
      First // Hierarchical
      {
        // Optional parameters
       GroupName "string"
       Level <int>
      }
      Second [ "string" <int> ]
      ... //other object parameters
    }
    ... // Extensions partameters
  }

To use these two configuration parameters use the following codes:

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

Definition at line 150 of file OMKControlTakeOverPrm.h.

---

Constructor & Destructor Documentation

AccessGroup::AccessGroup

(

)

Default constructor of AccessGroup.

Definition at line 38 of file OMKControlTakeOverPrm.cpp.

: _groupName( "" ),
  _level( 0 )
{
}

AccessGroup::AccessGroup

(

const AccessGroup &

ref

)

Copy constructor of AccessGroup.

Definition at line 46 of file OMKControlTakeOverPrm.cpp.

References _copy().

{
  _copy( ref ) ;
}

AccessGroup::AccessGroup	(	const Name &	groupName,
		AccessLevel	level
	)

Constructor of AccessGroup with all the parameters.

Definition at line 53 of file OMKControlTakeOverPrm.cpp.

: _groupName( groupName ),
  _level( level )
{
}

AccessGroup::~AccessGroup

(

)

[virtual]

Destructor of AccessGroup.

Definition at line 62 of file OMKControlTakeOverPrm.cpp.

{
}

---

Member Function Documentation

AccessGroup & AccessGroup::operator=

(

const AccessGroup &

ref

)

Copy operator.

Definition at line 68 of file OMKControlTakeOverPrm.cpp.

References _copy().

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

void AccessGroup::_copy

(

const AccessGroup &

q

)

[protected]

Copy.

Definition at line 79 of file OMKControlTakeOverPrm.cpp.

References _groupName, and _level.

Referenced by OMK::Type::AccessLevelList< ItemType >::_copy(), AccessGroup(), and operator=().

{
  _groupName = ref._groupName ; 
  _level = ref._level ; 
}

---

Friends And Related Function Documentation

friend class OMK::ParametersAccessor [friend]

Friend parametor accessor.

Reimplemented in OMK::Type::AccessLevelList< ItemType >.

Definition at line 189 of file OMKControlTakeOverPrm.h.

OMKIII_API bool operator!=	(	const AccessGroup &	a0,
		const AccessGroup &	a1
	)			[friend]

Inequality operator for AccessGroup.

Definition at line 92 of file OMKControlTakeOverPrm.cpp.

{
  return a0._groupName != a1._groupName
      || a0._level != a1._level ;
}

OMKIII_API bool operator==	(	const AccessGroup &	a0,
		const AccessGroup &	a1
	)			[friend]

Equality operator for AccessGroup.

Definition at line 184 of file OMKControlTakeOverPrm.h.

    { return !( a0 != a1 ) ; }

std::ostream& operator<<	(	std::ostream &	out,
		const AccessGroup &	a
	)			[friend]

stream operator for AccessGroup.

Use by SimpleTypeT::insertInStream.

Definition at line 104 of file OMKControlTakeOverPrm.cpp.

{
  out << a._groupName << " "
      << a._level << " "
      << " " ;
  return out ;
}

std::istream& operator>>	(	std::istream &	in,
		AccessGroup &	a
	)			[friend]

stream operator for AccessGroup.

Use by SimpleTypeT::extract.

Definition at line 114 of file OMKControlTakeOverPrm.cpp.

{
  in >> a._groupName
     >> a._level ;
  return in ;
}

OMK::OutgoingSynchronisationMessage& operator<<	(	OMK::OutgoingSynchronisationMessage &	out,
		const AccessGroup &	a
	)			[friend]

stream operator for AccessGroup.

Use by SimpleTypeT::pack.

Definition at line 123 of file OMKControlTakeOverPrm.cpp.

{
  out << a._groupName
      << a._level ;
  return out ;
}

OMK::IncomingSynchronisationMessage& operator>>	(	OMK::IncomingSynchronisationMessage &	in,
		AccessGroup &	a
	)			[friend]

stream operator for AccessGroup.

Use by SimpleTypeT::unpack.

Definition at line 132 of file OMKControlTakeOverPrm.cpp.

{
  in >> a._groupName
     >> a._level ;
  return in ;
}

---

Member Data Documentation

Name OMK::Type::AccessGroup::_groupName

This member holds the groupName value of AccessGroup.

Definition at line 172 of file OMKControlTakeOverPrm.h.

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

AccessLevel OMK::Type::AccessGroup::_level

This member holds the level value of AccessGroup.

Definition at line 174 of file OMKControlTakeOverPrm.h.

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

---