MIRA
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
FrameworkTransformerNode Class Reference

#include <fw/FrameworkTransformer.h>

Inheritance diagram for FrameworkTransformerNode:
Inheritance graph
[legend]

Public Types

enum  Type { UNSPECIFIED = 0, MOVING, FIXED }
 
typedef AbstractTransformerNodeAbstractNodePtr
 Pointer type for this AbstractTransformerNode. More...
 

Public Member Functions

virtual bool isEmpty () const
 Returns if the node has data or is empty. More...
 
template<typename Transform , typename Filter >
Transform getTransform (const Time &time, Filter &&filter)
 
Type getType () const
 
void setType (Type type)
 
const std::string & getID () const
 Returns the id of this node. More...
 
const std::list< AbstractNodePtr > & getChildren () const
 Returns a list with all children of this node. More...
 
const AbstractNodePtrgetParent () const
 Returns the parent of the node. More...
 
uint32 getDescendantCount () const
 Returns the number of descendants of this node (children, grandchildren, etc.) More...
 
bool isAncestorOf (const AbstractNodePtr other) const
 Returns true, if the this node is an ancestor of the given 'other' node. More...
 

Protected Member Functions

 FrameworkTransformerNode (const std::string &id, Authority &authority)
 Creates a new node of the transform tree, that can be added to the corresponding FrameworkTransformer using addNode(). More...
 

Protected Attributes

std::string mID
 The id of this node. More...
 
AbstractNodePtr mParent
 Pointer to the parent node within the tree. More...
 
std::list< AbstractNodePtrmChildren
 List with pointers to the children within the transformation tree. More...
 

Friends

class FrameworkTransformer
 

Member Typedef Documentation

◆ AbstractNodePtr

Pointer type for this AbstractTransformerNode.

Member Enumeration Documentation

◆ Type

enum Type
Enumerator
UNSPECIFIED 
MOVING 
FIXED 

Constructor & Destructor Documentation

◆ FrameworkTransformerNode()

FrameworkTransformerNode ( const std::string &  id,
Authority authority 
)
inlineprotected

Creates a new node of the transform tree, that can be added to the corresponding FrameworkTransformer using addNode().

Note
The constructors of Node are protected. New nodes can only be created using FrameworkTransformer::addLink().

Member Function Documentation

◆ isEmpty()

bool isEmpty ( ) const
inlinevirtual

Returns if the node has data or is empty.

Implements AbstractTransformerNode.

◆ getTransform()

Transform getTransform ( const Time time,
Filter &&  filter 
)
inline

◆ getType()

FrameworkTransformerNode::Type getType ( ) const
inline

◆ setType()

void setType ( FrameworkTransformerNode::Type  type)
inline

◆ getID()

const std::string& getID ( ) const
inlineinherited

Returns the id of this node.

◆ getChildren()

const std::list<AbstractNodePtr>& getChildren ( ) const
inlineinherited

Returns a list with all children of this node.

◆ getParent()

const AbstractNodePtr& getParent ( ) const
inlineinherited

Returns the parent of the node.

◆ getDescendantCount()

uint32 getDescendantCount ( ) const
inherited

Returns the number of descendants of this node (children, grandchildren, etc.)

◆ isAncestorOf()

bool isAncestorOf ( const AbstractNodePtr  other) const
inherited

Returns true, if the this node is an ancestor of the given 'other' node.

Friends And Related Function Documentation

◆ FrameworkTransformer

friend class FrameworkTransformer
friend

Member Data Documentation

◆ mID

std::string mID
protectedinherited

The id of this node.

◆ mParent

AbstractNodePtr mParent
protectedinherited

Pointer to the parent node within the tree.

◆ mChildren

std::list<AbstractNodePtr> mChildren
protectedinherited

List with pointers to the children within the transformation tree.


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