Fawkes API  Fawkes Development Version
fawkes::RCSoftMapNode Class Reference

RCSoft map node representation. More...

#include <>>

Public Member Functions

 RCSoftMapNode ()
 Constructor for invalid node. More...
 
 RCSoftMapNode (std::string name, float x, float y, std::vector< std::string > children, std::vector< std::string > properties, std::vector< std::string > aliases)
 Constructor. More...
 
const std::string & name () const
 Get node name. More...
 
float x () const
 Get node X coordinate. More...
 
float y () const
 Get node Y coordinate. More...
 
std::vector< std::string > & properties ()
 Get properties of node. More...
 
std::vector< std::string > & aliases ()
 Get aliases. More...
 
std::vector< std::string > & children ()
 Get children of node. More...
 
bool has_property (std::string property)
 Check if node has a specific property. More...
 
bool has_alias (std::string property)
 Check if node has a specific alias. More...
 
bool is_valid () const
 Check if the node is valid. More...
 

Detailed Description

RCSoft map node representation.

Author
Tim Niemueller

Definition at line 37 of file rcsoft_map_node.h.

Constructor & Destructor Documentation

fawkes::RCSoftMapNode::RCSoftMapNode ( )

Constructor for invalid node.

Definition at line 41 of file rcsoft_map_node.cpp.

fawkes::RCSoftMapNode::RCSoftMapNode ( std::string  name,
float  x,
float  y,
std::vector< std::string >  children,
std::vector< std::string >  properties,
std::vector< std::string >  aliases 
)

Constructor.

Parameters
namename of the node
xWorld X coordinate of the node
yWorld Y position of the node
childrenvector of child nodes
propertiesvector of properties
aliasesvector of aliases

Definition at line 60 of file rcsoft_map_node.cpp.

References aliases(), children(), name(), properties(), x(), and y().

Member Function Documentation

std::vector< std::string > & fawkes::RCSoftMapNode::aliases ( )

Get aliases.

Returns
reference to vector of aliases

Definition at line 128 of file rcsoft_map_node.cpp.

Referenced by RCSoftMapNode().

std::vector< std::string > & fawkes::RCSoftMapNode::children ( )

Get children of node.

Returns
reference to vector of child node names

Definition at line 108 of file rcsoft_map_node.cpp.

Referenced by fawkes::EclExternalRCSoftMapGraph::map_graph(), and RCSoftMapNode().

bool fawkes::RCSoftMapNode::has_alias ( std::string  alias)

Check if node has a specific alias.

Parameters
aliasalias to check for
Returns
true if the node has the specified alias, false otherwise

Definition at line 150 of file rcsoft_map_node.cpp.

bool fawkes::RCSoftMapNode::has_property ( std::string  property)

Check if node has a specific property.

Parameters
propertyproperty to check for
Returns
true if the node has the specified property, false otherwise

Definition at line 139 of file rcsoft_map_node.cpp.

bool fawkes::RCSoftMapNode::is_valid ( ) const

Check if the node is valid.

Returns
true if the node is valid, false otherwise

Definition at line 160 of file rcsoft_map_node.cpp.

const std::string & fawkes::RCSoftMapNode::name ( ) const

Get node name.

Returns
node name

Definition at line 78 of file rcsoft_map_node.cpp.

Referenced by fawkes::EclExternalRCSoftMapGraph::map_graph(), and RCSoftMapNode().

std::vector< std::string > & fawkes::RCSoftMapNode::properties ( )

Get properties of node.

Returns
reference to vector of properties

Definition at line 118 of file rcsoft_map_node.cpp.

Referenced by fawkes::EclExternalRCSoftMapGraph::map_graph(), and RCSoftMapNode().

float fawkes::RCSoftMapNode::x ( ) const

Get node X coordinate.

Returns
node X coordinate

Definition at line 88 of file rcsoft_map_node.cpp.

Referenced by fawkes::EclExternalRCSoftMapGraph::map_graph(), and RCSoftMapNode().

float fawkes::RCSoftMapNode::y ( ) const

Get node Y coordinate.

Returns
node Y coordinate

Definition at line 98 of file rcsoft_map_node.cpp.

Referenced by fawkes::EclExternalRCSoftMapGraph::map_graph(), and RCSoftMapNode().


The documentation for this class was generated from the following files: