Aria  2.8.0
ArMapFileLineSetWriter Class Reference

Functor that populates a specified ArMapFileLineSet. More...

#include <ArMapUtils.h>

Inherits ArFunctor1< const char *>.

Public Member Functions

 ArMapFileLineSetWriter (ArMapFileLineSet *multiSet)
 Constructs a new writer for the given map file line set.
 
virtual void invoke (void)
 Invokes the functor; this method shouldn't be called.
 
virtual void invoke (const char *p1)
 Invokes the functor. More...
 
bool isAddingChildren () const
 Returns whether children are currently being added to the map file line set.
 
void setAddingChildren (bool isAddingChildren)
 Sets whether children are currently being added to the map file line set. More...
 
 ~ArMapFileLineSetWriter ()
 Destructor.
 
- Public Member Functions inherited from ArFunctor1< const char *>
virtual ~ArFunctor1 ()
 Destructor.
 
- Public Member Functions inherited from ArFunctor
virtual const char * getName (void)
 Gets the name of the functor.
 
virtual void setName (const char *name)
 Sets the name of the functor.
 
virtual void setNameVar (const char *name,...)
 Sets the name of the functor with formatting. More...
 
virtual ~ArFunctor ()
 Destructor.
 

Protected Attributes

int myChildLineNum
 "Local" line number of the current child in relation to its parent
 
bool myIsAddingChildren
 Whether a child is currently being added.
 
int myLineNum
 Line number currently being written.
 
ArMapFileLineSetmyMultiSet
 Map file line set that is being populated.
 
- Protected Attributes inherited from ArFunctor
std::string myName
 

Detailed Description

Functor that populates a specified ArMapFileLineSet.

ArMapFileLineSetWriter is used to create an ArMapFileLineSet, using the normal Aria map writeToFunctor mechanism.

Java and Python Wrappers: Not available in Java or Python wrapper libraries.

Member Function Documentation

◆ invoke()

virtual void ArMapFileLineSetWriter::invoke ( const char *  p1)
inlinevirtual

Invokes the functor.

Parameters
p1the char * map file line to be written

Implements ArFunctor1< const char *>.

◆ setAddingChildren()

void ArMapFileLineSetWriter::setAddingChildren ( bool  isAddingChildren)
inline

Sets whether children are currently being added to the map file line set.

When a child line is detected by the map file parser, setAddingChildren(true) must be called. The new children will be added to the most recently created ArMapFileLineSet. Likewise, when the child list is complete, setAddingChildren(false) must be called.


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