Actin®  Version 5.3.0
Software for Robotics Simulation and Control
ecEndEffectorMap.h
Go to the documentation of this file.
1 #ifndef ecEndEffectorMap_H_
2 #define ecEndEffectorMap_H_
3 //------------------------------------------------------------------------------
4 // Copyright (c) 2015 Energid Technologies. All rights reserved.
5 //
9 //
10 //------------------------------------------------------------------------------
11 
12 #include <actinCore/actinCore_config.h> // Required to be first header.
13 
14 #include "ecEndEffector.h"
15 #include <xml/ecXmlVarMapType.h>
16 
19 
21 {
22 public:
23 
27 
29  virtual EcXmlObject* clone
30  (
31  ) const EC_OVERRIDE;
32 
34  virtual EcBoolean equality
35  (
36  const EcXmlObject* other
37  ) const EC_OVERRIDE;
38 
40  virtual EcXmlObject* newObject
41  (
42  ) const EC_OVERRIDE;
43 
45  virtual const EcToken& token
46  (
47  ) const EC_OVERRIDE;
48 
50  virtual EcBoolean read
51  (
52  EcXmlReader& stream
53  ) EC_OVERRIDE;
54 
56  virtual EcBoolean write
57  (
58  EcXmlWriter& stream
59  ) const EC_OVERRIDE;
60 
62  virtual void registerComponentCreators
63  (
64  ) EC_OVERRIDE;
65 
68  static EcEndEffectorMap nullObject
69  (
70  );
71 
76  virtual EcBoolean setRelativeLinkData
77  (
78  const EcXmlString& key,
79  const EcEndEffectorRelativeLinkData relativeLinkData
80  );
81 
85  virtual EcEndEffector* endEffectorFromToken
86  (
87  const EcToken& token
88  );
89 };
90 
91 #endif // ecEndEffectorMap_H_
virtual const EcToken & token() const =0
gets the xml token used for writing out.
ECDECLARE_BIGFOUR(EcXmlBaseVariableCompoundType)
Holds a description of the relative nature of an end effector.
virtual EcBoolean read(EcXmlReader &stream) EC_OVERRIDE
read this object from an XML stream
virtual void registerComponentCreators() EC_OVERRIDE
Elements in this variable map can be registered by overriding this virtual method. Default implementation is empty and supports only plugin types with library attribute.
#define EC_OVERRIDE
Add wrapper around c++11 override keyword.
Definition: ecMacros.h:36
#define EC_ACTINCORE_CONTROLCORE_DECL
controlCore directory
virtual EcBoolean write(EcXmlWriter &stream) const EC_OVERRIDE
write this object to an XML stream
Holds a base class for single end-effector components.
Definition: ecEndEffector.h:32
An EcString-like class that holds a tag and a namespace.
Definition: ecToken.h:41
A base class for xml objects.
Definition: ecXmlObject.h:23
Configuration header for the foundation hierarchy.
virtual EcXmlObject * clone() const =0
clone
bool EcBoolean
Boolean (0 or 1)
Definition: ecTypes.h:21
A template class that is XML readable/writable for holding maps of XML objects.
XML file writer.
Definition: ecXmlWriter.h:19
virtual EcBoolean equality(const EcXmlObject *other) const =0
equality - a virtual equality to an EcXmlObject pointer
virtual EcXmlObject * newObject() const =0
creates new object - a virtual new to an EcXmlObject pointer
Holds a description of a map of general end effectors.
An XML file reader.
Definition: ecXmlReader.h:17
EcXmlVariableMapType< EcXmlString, EcEndEffector > EcBaseGeneralEndEffectorMap
type definition of XML variable map of EcEndEffector to be used as a base class
Created by Energid Technologies www.energid.com
Copyright © 2016 Energid. All trademarks mentioned in this document are property of their respective owners.