blob: 78af4037a66dba62166f468c1229351f39a6cec8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
// Copyright (C) by Josh Blum. See LICENSE.txt for licensing information.
#ifndef INCLUDED_GRAS_ELEMENT_HPP
#define INCLUDED_GRAS_ELEMENT_HPP
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning (disable:4251) // needs to have dll interface
#endif //_MSC_VER
#include <gras/gras.hpp>
#include <boost/shared_ptr.hpp>
namespace gras
{
struct ElementImpl;
typedef boost::shared_ptr<ElementImpl> ElementBase;
struct Block;
/*!
* Weak Element interface class:
* Allows internals to get a reference to the container holding an element.
* This container could be a shared_ptr or perhaps a Python object.
*/
struct WeakElement
{
//! Lock creates a shared pointer holding a container reference
virtual boost::shared_ptr<const void> lock(void) = 0;
};
/*!
* Element is a base class for all topological elements.
*/
struct GRAS_API Element : ElementBase
{
//! Create an empty element
Element(void);
//! Creates a new element given the name
Element(const std::string &name);
/*!
* Create an element from a shared pointer to an element.
* Good for that factory function/shared ptr paradigm.
*/
template <typename T>
Element(const boost::shared_ptr<T> &elem);
virtual ~Element(void);
//! Convert this object to the element base class
const Element &to_element(void) const;
//! Convert this object to the element base class
Element &to_element(void);
/*!
* Check if another element is the same as this one.
* \return true if the rhs is the same as *this.
*/
bool equals(const Element &rhs);
/*******************************************************************
* identification interface
******************************************************************/
//! An integer ID that is unique across the process
long unique_id(void) const;
//! Get the name of this element
std::string name(void) const;
//! get a canonical name for this element
std::string to_string(void) const;
/*******************************************************************
* element tree interface
******************************************************************/
/*!
* Adopt an element as a child under the given name.
*
* This API allows the user to structure a hierarchy of elements.
* This element will become the parent of the child element.
*
* \param name the name of the child node
* \param child an element to be adopted
*/
void adopt_element(const std::string &name, const Element &child);
/*!
* Locate a block in the element tree hierarchy.
*
* Paths are unix style, absolte and relatives paths are possible.
* This call throws an invalid argument when bad paths are given.
*
* Example path: /my_hier_block/my_block0
* Example path: ../my_block1
*
* \param path a path to a block (leaf) in the tree
* \return a pointer to the block
*/
Block *locate_block(const std::string &path);
/*******************************************************************
* API for dealing with parent containers - for internal use
******************************************************************/
/*!
* Allows internals to get a reference to the container holding an element.
* This container could be a shared_ptr or perhaps a Python object.
*/
boost::shared_ptr<WeakElement> weak_self;
};
} //namespace gras
#include <gras/detail/element.hpp>
#ifdef _MSC_VER
#pragma warning(pop)
#endif //_MSC_VER
#endif /*INCLUDED_GRAS_ELEMENT_HPP*/
|
