OMK::Type::AccessibleParameterPrm

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

Class AccessibleParameterPrm generated. More...

#include <OMKAccessibleParameterPrm.h>

Collaboration diagram for OMK::Type::AccessibleParameterPrm:

Collaboration graph
[legend]
List of all members.

Constructors and destructor.

 AccessibleParameterPrm ()
 Default constructor of AccessibleParameterPrm.
 AccessibleParameterPrm (const AccessibleParameterPrm &ref)
 Copy constructor of AccessibleParameterPrm.
 AccessibleParameterPrm (const OMK::Iii::IConnector *connector, const AccessGroup &accessGroup)
 Constructor of AccessibleParameterPrm based on the connector parameters.
 AccessibleParameterPrm (OMK::Name id, OMK::Name category, OMK::Name type, bool accessible, const std::map< OMK::Name, int > &levels, const std::list< OMK::Name > &toolsInUse)
 Constructor of AccessibleParameterPrm with all the parameters.
virtual ~AccessibleParameterPrm ()
 Destructor of AccessibleParameterPrm.
AccessibleParameterPrm & operator= (const AccessibleParameterPrm &ref)
 Copy operator.

Public Attributes

Public members
OMK::Name _id
 This member holds the id value of AccessibleParameterPrm.
OMK::Name _category
 This member holds the category value of AccessibleParameterPrm.
OMK::Name _type
 This member holds the type value of AccessibleParameterPrm.
bool _accessible
 This member holds the accessible value of AccessibleParameterPrm.
std::map< OMK::Name, int > _levels
 This member holds the levels values of AccessibleParameterPrm.
std::list< OMK::Name > _toolsInUse
 This member holds the toolsInUse values of AccessibleParameterPrm.

Protected Member Functions

void _copy (const AccessibleParameterPrm &q)
 Copy.

Friends

class OMK::ParametersAccessor
 Friend parametor accessor.
Friend compare operators.
OMKIII_API bool operator!= (const AccessibleParameterPrm &a0, const AccessibleParameterPrm &a1)
 Inequality operator for AccessibleParameterPrm.
OMKIII_API bool operator== (const AccessibleParameterPrm &a0, const AccessibleParameterPrm &a1)
 Equality operator for AccessibleParameterPrm.
Friend stream operators.
std::ostream & operator<< (std::ostream &out, const AccessibleParameterPrm &a)
 stream operator for AccessibleParameterPrm.
std::istream & operator>> (std::istream &in, AccessibleParameterPrm &a)
 stream operator for AccessibleParameterPrm.
OMK::OutgoingSynchronisationMessage & operator<< (OMK::OutgoingSynchronisationMessage &out, const AccessibleParameterPrm &a)
 stream operator for AccessibleParameterPrm.
OMK::IncomingSynchronisationMessage & operator>> (OMK::IncomingSynchronisationMessage &in, AccessibleParameterPrm &a)
 stream operator for AccessibleParameterPrm.

Detailed Description

Class AccessibleParameterPrm generated.

Date:
generated the 2008-05-20 at 10:10:24
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. 
  myObject
  {
    Class ObjectWhichUsesAccessibleParameterPrm
    ... // Scheduling partameters
    UserParams
    {
      First // Hierarchical
      {
        // Optional parameters
       Id "id"
       Category "id"
       Type "id"
       Accessible on|off
       Levels [ ["id" <int> ] ... ]
       ToolsInUse [ "id" ... ]
      }
      Second [ "id" "id" "id" on|off [ ["id" <int> ] ... ] [ "id" ... ] ]
      ... //other object parameters
    }
    ... // Extensions partameters
  }
To use these two configuration parameters use the following codes:
  OMK::Type::AccessibleParameterPrm _first ;
  OMK::Type::AccessibleParameterPrm _second ;
  OMK::ParametersAccessor::get( node, "First", _first ) ;
  OMK::ParametersAccessor::get( node, "Second", _second ) ;

Definition at line 138 of file OMKAccessibleParameterPrm.h.

Constructor & Destructor Documentation

AccessibleParameterPrm::AccessibleParameterPrm (  ) 

Default constructor of AccessibleParameterPrm.

Definition at line 34 of file OMKAccessibleParameterPrm.cpp.

00035 : _id( OMK::Name() ),
00036   _category( OMK::Name() ),
00037   _type( OMK::Name() ),
00038   _accessible( false ),
00039   _levels(),
00040   _toolsInUse()
00041 {
00042 }

AccessibleParameterPrm::AccessibleParameterPrm ( const AccessibleParameterPrm &  ref  ) 

Copy constructor of AccessibleParameterPrm.

Definition at line 46 of file OMKAccessibleParameterPrm.cpp.

References _copy().

00047 {
00048   _copy( ref ) ;
00049 }

AccessibleParameterPrm::AccessibleParameterPrm ( const OMK::Iii::IConnector *  connector,
const AccessGroup &  accessGroup 
)

Constructor of AccessibleParameterPrm based on the connector parameters.

Definition at line 53 of file OMKAccessibleParameterPrm.cpp.

00055 : _id( connector->id() ),
00056   _category( connector->category() ),
00057   _type( connector->type() ),
00058   _accessible( connector->getAccessRule().isAccessGranted( accessGroup._level, accessGroup._groupName ) ),
00059   _levels( connector->getAccessRule().getCurrentAccessLevel() ),
00060   _toolsInUse( connector->getToolsInUse() )
00061 {
00062 }

AccessibleParameterPrm::AccessibleParameterPrm ( OMK::Name  id,
OMK::Name  category,
OMK::Name  type,
bool  accessible,
const std::map< OMK::Name, int > &  levels,
const std::list< OMK::Name > &  toolsInUse 
)

Constructor of AccessibleParameterPrm with all the parameters.

Definition at line 66 of file OMKAccessibleParameterPrm.cpp.

00072 : _id( id ),
00073   _category( category ),
00074   _type( type ),
00075   _accessible( accessible ),
00076   _levels( levels ),
00077   _toolsInUse( toolsInUse )
00078 {
00079 }

AccessibleParameterPrm::~AccessibleParameterPrm (  )  [virtual]

Destructor of AccessibleParameterPrm.

Definition at line 83 of file OMKAccessibleParameterPrm.cpp.

00084 {
00085 }

Member Function Documentation

AccessibleParameterPrm & AccessibleParameterPrm::operator= ( const AccessibleParameterPrm &  ref  ) 

Copy operator.

Definition at line 89 of file OMKAccessibleParameterPrm.cpp.

References _copy().

00090 {
00091   if ( this != &ref )
00092   {
00093     _copy( ref ) ;
00094   }
00095   return *this ;
00096 }

void AccessibleParameterPrm::_copy ( const AccessibleParameterPrm &  q  )  [protected]

Copy.

Definition at line 100 of file OMKAccessibleParameterPrm.cpp.

References _accessible, _category, _id, _levels, _toolsInUse, and _type.

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

00101 {
00102   _id = ref._id ; 
00103   _category = ref._category ; 
00104   _type = ref._type ; 
00105   _accessible = ref._accessible ; 
00106   _levels = ref._levels ; 
00107   _toolsInUse = ref._toolsInUse ; 
00108 }

Friends And Related Function Documentation

friend class OMK::ParametersAccessor [friend]

Friend parametor accessor.

Definition at line 194 of file OMKAccessibleParameterPrm.h.

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

Inequality operator for AccessibleParameterPrm.

Definition at line 117 of file OMKAccessibleParameterPrm.cpp.

00118 {
00119   return a0._id != a1._id
00120       || a0._category != a1._category
00121       || a0._type != a1._type
00122       || a0._accessible != a1._accessible
00123       || a0._levels != a1._levels
00124       || a0._toolsInUse != a1._toolsInUse ;
00125 }

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

Equality operator for AccessibleParameterPrm.

Definition at line 189 of file OMKAccessibleParameterPrm.h.

00190     { return !( a0 != a1 ) ; }

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

stream operator for AccessibleParameterPrm.

Use by SimpleTypeT::insertInStream.

Definition at line 133 of file OMKAccessibleParameterPrm.cpp.

00134 {
00135   out << a._id << " "
00136       << a._category << " "
00137       << a._type << " "
00138       << a._accessible << " "
00139       << a._levels << " "
00140       << a._toolsInUse << " "
00141       << " " ;
00142   return out ;
00143 }

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

stream operator for AccessibleParameterPrm.

Use by SimpleTypeT::extract.

Definition at line 147 of file OMKAccessibleParameterPrm.cpp.

00148 {
00149   in >> a._id
00150      >> a._category
00151      >> a._type
00152      >> a._accessible
00153      >> a._levels
00154      >> a._toolsInUse ;
00155   return in ;
00156 }

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

stream operator for AccessibleParameterPrm.

Use by SimpleTypeT::pack.

Definition at line 160 of file OMKAccessibleParameterPrm.cpp.

00161 {
00162   out << a._id
00163       << a._category
00164       << a._type
00165       << a._accessible
00166       << a._levels
00167       << a._toolsInUse ;
00168   return out ;
00169 }

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

stream operator for AccessibleParameterPrm.

Use by SimpleTypeT::unpack.

Definition at line 173 of file OMKAccessibleParameterPrm.cpp.

00174 {
00175   in >> a._id
00176      >> a._category
00177      >> a._type
00178      >> a._accessible
00179      >> a._levels
00180      >> a._toolsInUse ;
00181   return in ;
00182 }

Member Data Documentation

OMK::Name OMK::Type::AccessibleParameterPrm::_id

This member holds the id value of AccessibleParameterPrm.

Definition at line 167 of file OMKAccessibleParameterPrm.h.

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

OMK::Name OMK::Type::AccessibleParameterPrm::_category

This member holds the category value of AccessibleParameterPrm.

Definition at line 169 of file OMKAccessibleParameterPrm.h.

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

OMK::Name OMK::Type::AccessibleParameterPrm::_type

This member holds the type value of AccessibleParameterPrm.

Definition at line 171 of file OMKAccessibleParameterPrm.h.

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

bool OMK::Type::AccessibleParameterPrm::_accessible

This member holds the accessible value of AccessibleParameterPrm.

Definition at line 175 of file OMKAccessibleParameterPrm.h.

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

std::map< OMK::Name, int > OMK::Type::AccessibleParameterPrm::_levels

This member holds the levels values of AccessibleParameterPrm.

Definition at line 177 of file OMKAccessibleParameterPrm.h.

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

std::list< OMK::Name > OMK::Type::AccessibleParameterPrm::_toolsInUse

This member holds the toolsInUse values of AccessibleParameterPrm.

Definition at line 179 of file OMKAccessibleParameterPrm.h.

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

logo OpenMask

Documentation generated on Mon Jun 9 11:46:05 2008

Generated with doxygen by Dimitri van Heesch ,   1997-2007