Choreonoid  1.5
Public Types | Public Member Functions | Friends | List of all members
cnoid::Mapping Class Reference

#include <ValueTree.h>

Inheritance diagram for cnoid::Mapping:
cnoid::ValueNode cnoid::Referenced cnoid::Archive

Public Types

enum  AssignMode { READ_MODE, WRITE_MODE }
 
typedef Container::iterator iterator
 
typedef Container::const_iterator const_iterator
 
- Public Types inherited from cnoid::ValueNode
enum  TypeBit {
  INVALID_NODE = 0, SCALAR = 1, MAPPING = 2, LISTING = 4,
  INSERT_LF = 8, APPEND_LF = 16
}
 

Public Member Functions

 Mapping ()
 
 Mapping (int line, int column)
 
virtual ~Mapping ()
 
virtual ValueNodeclone () const
 
bool empty () const
 
int size () const
 
void clear ()
 
void setFlowStyle (bool isFlowStyle=true)
 
bool isFlowStyle () const
 
void setDoubleFormat (const char *format)
 
const char * doubleFormat ()
 
void setKeyQuoteStyle (StringStyle style)
 
ValueNodefind (const std::string &key) const
 
MappingfindMapping (const std::string &key) const
 
ListingfindListing (const std::string &key) const
 
ValueNodePtr extract (const std::string &key)
 
ValueNodeget (const std::string &key) const
 
ValueNodeoperator[] (const std::string &key) const
 
void insert (const std::string &key, ValueNode *node)
 
void insert (const Mapping *other)
 
MappingopenMapping (const std::string &key)
 
MappingopenFlowStyleMapping (const std::string &key)
 
MappingcreateMapping (const std::string &key)
 
MappingcreateFlowStyleMapping (const std::string &key)
 
ListingopenListing (const std::string &key)
 
ListingopenFlowStyleListing (const std::string &key)
 
ListingcreateListing (const std::string &key)
 
ListingcreateFlowStyleListing (const std::string &key)
 
bool remove (const std::string &key)
 
bool read (const std::string &key, std::string &out_value) const
 
bool readUTF8 (const std::string &key, std::string &out_value) const
 
bool read (const std::string &key, bool &out_value) const
 
bool read (const std::string &key, int &out_value) const
 
bool read (const std::string &key, double &out_value) const
 
template<class T >
read (const std::string &key) const
 
template<class T >
get (const std::string &key, const T &defaultValue) const
 
std::string get (const std::string &key, const char *defaultValue) const
 
void writeUTF8 (const std::string &key, const std::string &value, StringStyle stringStyle=PLAIN_STRING)
 
void write (const std::string &key, const std::string &value, StringStyle stringStyle=PLAIN_STRING)
 
void writeUTF8 (const std::string &key, const char *value, StringStyle stringStyle=PLAIN_STRING)
 
void write (const std::string &key, const char *value, StringStyle stringStyle=PLAIN_STRING)
 
void write (const std::string &key, bool value)
 
void write (const std::string &key, int value)
 
void write (const std::string &key, double value)
 
void writePath (const std::string &key, const std::string &value)
 
void setAssignMode (AssignMode mode)
 
template<class T >
void assign (const std::string &key, T &io_value, const T &defaultValue)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
void throwKeyNotFoundException (const std::string &key) const
 
- Public Member Functions inherited from cnoid::ValueNode
bool isValid () const
 
TypeBit LFType () const
 
TypeBit nodeType () const
 
int toInt () const
 
double toDouble () const
 
bool toBool () const
 
bool isScalar () const
 
bool isString () const
 
const std::string & toString () const
 
const std::string & toUTF8String () const
 
 operator const std::string & () const
 
template<typename T >
to () const
 
bool isMapping () const
 
const MappingtoMapping () const
 
MappingtoMapping ()
 
bool isListing () const
 
const ListingtoListing () const
 
ListingtoListing ()
 
bool read (int &out_value) const
 
bool read (double &out_value) const
 
bool read (bool &out_value) const
 
bool read (std::string &out_value) const
 
bool readUTF8String (std::string &out_value) const
 
bool hasLineInfo () const
 
int line () const
 
int column () const
 
void throwException (const std::string &message) const
 
template<>
double to () const
 
template<>
int to () const
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 
void addRef ()
 
void releaseRef ()
 

Friends

class Listing
 
class YAMLReaderImpl
 
class YAMLWriter
 

Additional Inherited Members

- Protected Member Functions inherited from cnoid::ValueNode
 ValueNode ()
 
 ValueNode (TypeBit type)
 
virtual ~ValueNode ()
 
void throwNotScalrException () const
 
void throwNotMappingException () const
 
void throwNotListingException () const
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 
- Protected Attributes inherited from cnoid::ValueNode
int typeBits
 

Member Typedef Documentation

◆ const_iterator

typedef Container::const_iterator cnoid::Mapping::const_iterator

◆ iterator

typedef Container::iterator cnoid::Mapping::iterator

Member Enumeration Documentation

◆ AssignMode

Enumerator
READ_MODE 
WRITE_MODE 

Constructor & Destructor Documentation

◆ Mapping() [1/2]

Mapping::Mapping ( )

◆ Mapping() [2/2]

Mapping::Mapping ( int  line,
int  column 
)

◆ ~Mapping()

Mapping::~Mapping ( )
virtual

Member Function Documentation

◆ assign()

template<class T >
void cnoid::Mapping::assign ( const std::string &  key,
T &  io_value,
const T &  defaultValue 
)
inline

◆ begin() [1/2]

iterator cnoid::Mapping::begin ( )
inline

◆ begin() [2/2]

const_iterator cnoid::Mapping::begin ( ) const
inline

◆ clear()

void Mapping::clear ( )

◆ clone()

ValueNode * Mapping::clone ( ) const
virtual

Reimplemented from cnoid::ValueNode.

◆ createFlowStyleListing()

Listing* cnoid::Mapping::createFlowStyleListing ( const std::string &  key)
inline

◆ createFlowStyleMapping()

Mapping* cnoid::Mapping::createFlowStyleMapping ( const std::string &  key)
inline

◆ createListing()

Listing* cnoid::Mapping::createListing ( const std::string &  key)
inline

◆ createMapping()

Mapping* cnoid::Mapping::createMapping ( const std::string &  key)
inline

◆ doubleFormat()

const char* cnoid::Mapping::doubleFormat ( )
inline

◆ empty()

bool cnoid::Mapping::empty ( ) const
inline

◆ end() [1/2]

iterator cnoid::Mapping::end ( )
inline

◆ end() [2/2]

const_iterator cnoid::Mapping::end ( ) const
inline

◆ extract()

ValueNodePtr Mapping::extract ( const std::string &  key)

◆ find()

ValueNode * Mapping::find ( const std::string &  key) const

◆ findListing()

Listing * Mapping::findListing ( const std::string &  key) const

◆ findMapping()

Mapping * Mapping::findMapping ( const std::string &  key) const

◆ get() [1/3]

ValueNode & Mapping::get ( const std::string &  key) const

◆ get() [2/3]

template<class T >
T cnoid::Mapping::get ( const std::string &  key,
const T &  defaultValue 
) const
inline

◆ get() [3/3]

std::string cnoid::Mapping::get ( const std::string &  key,
const char *  defaultValue 
) const
inline

◆ insert() [1/2]

void Mapping::insert ( const std::string &  key,
ValueNode node 
)

◆ insert() [2/2]

void Mapping::insert ( const Mapping other)

◆ isFlowStyle()

bool cnoid::Mapping::isFlowStyle ( ) const
inline

◆ openFlowStyleListing()

Listing* cnoid::Mapping::openFlowStyleListing ( const std::string &  key)
inline

◆ openFlowStyleMapping()

Mapping* cnoid::Mapping::openFlowStyleMapping ( const std::string &  key)
inline

◆ openListing()

Listing* cnoid::Mapping::openListing ( const std::string &  key)
inline

◆ openMapping()

Mapping* cnoid::Mapping::openMapping ( const std::string &  key)
inline

◆ operator[]()

ValueNode& cnoid::Mapping::operator[] ( const std::string &  key) const
inline

◆ read() [1/5]

bool Mapping::read ( const std::string &  key,
std::string &  out_value 
) const

◆ read() [2/5]

bool Mapping::read ( const std::string &  key,
bool &  out_value 
) const

◆ read() [3/5]

bool Mapping::read ( const std::string &  key,
int &  out_value 
) const

◆ read() [4/5]

bool Mapping::read ( const std::string &  key,
double &  out_value 
) const

◆ read() [5/5]

template<class T >
T cnoid::Mapping::read ( const std::string &  key) const
inline

◆ readUTF8()

bool Mapping::readUTF8 ( const std::string &  key,
std::string &  out_value 
) const

◆ remove()

bool Mapping::remove ( const std::string &  key)

◆ setAssignMode()

void cnoid::Mapping::setAssignMode ( AssignMode  mode)
inline

◆ setDoubleFormat()

void Mapping::setDoubleFormat ( const char *  format)

◆ setFlowStyle()

void cnoid::Mapping::setFlowStyle ( bool  isFlowStyle = true)
inline

◆ setKeyQuoteStyle()

void Mapping::setKeyQuoteStyle ( StringStyle  style)

◆ size()

int cnoid::Mapping::size ( ) const
inline

◆ throwKeyNotFoundException()

void Mapping::throwKeyNotFoundException ( const std::string &  key) const

◆ write() [1/5]

void cnoid::Mapping::write ( const std::string &  key,
const std::string &  value,
StringStyle  stringStyle = PLAIN_STRING 
)
inline

◆ write() [2/5]

void cnoid::Mapping::write ( const std::string &  key,
const char *  value,
StringStyle  stringStyle = PLAIN_STRING 
)
inline

◆ write() [3/5]

void Mapping::write ( const std::string &  key,
bool  value 
)

◆ write() [4/5]

void Mapping::write ( const std::string &  key,
int  value 
)

◆ write() [5/5]

void Mapping::write ( const std::string &  key,
double  value 
)

◆ writePath()

void Mapping::writePath ( const std::string &  key,
const std::string &  value 
)

◆ writeUTF8() [1/2]

void Mapping::writeUTF8 ( const std::string &  key,
const std::string &  value,
StringStyle  stringStyle = PLAIN_STRING 
)

◆ writeUTF8() [2/2]

void cnoid::Mapping::writeUTF8 ( const std::string &  key,
const char *  value,
StringStyle  stringStyle = PLAIN_STRING 
)
inline

Friends And Related Function Documentation

◆ Listing

friend class Listing
friend

◆ YAMLReaderImpl

friend class YAMLReaderImpl
friend

◆ YAMLWriter

friend class YAMLWriter
friend

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