fw4spl
fwAtoms::String Class Reference

Class represented a String. More...

#include <String.hpp>

+ Inheritance diagram for fwAtoms::String:
+ Collaboration diagram for fwAtoms::String:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
 String (::fwAtoms::Base::Key key)
 Constructor. More...
 
virtual ~String ()
 Destructor.
 
const std::string & getValue () const
 
void setValue (const std::string &value)
 
std::string getString () const override
 Return the string representation of a value. More...
 
virtual FWATOMS_API Base::sptr clone () const override
 Returns a clone object.
 
::fwAtoms::Base::AtomType type () const override
 returns Atom type
 
- Public Member Functions inherited from fwAtoms::Base
bool isValue () const
 Test if the current base is a value or not (Value = {string;numeric;boolean}) More...
 
bool isBoolean () const
 Test if the current base is a boolean. More...
 
bool isNumeric () const
 Test if the current base is a Numeric (real or integer) More...
 
bool isString () const
 Test if the current base is a string. More...
 
bool isSequence () const
 Test if the current base is a sequence. More...
 
bool isMapping () const
 Test if the current base is a mapping. More...
 
bool isBlob () const
 Test if the current base is a blob (a object with a buffer) More...
 
bool isObject () const
 Test if the current base is an object (representation of fwData) More...
 
- Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
static FWATOMS_API String::sptr New (std::string value)
 Construct a new Object represented a string. More...
 
- Static Public Member Functions inherited from fwAtoms::Base
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwCore::BaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Protected Attributes

std::string m_value
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Additional Inherited Members

- Public Types inherited from fwAtoms::Base
enum  AtomType {
  BOOLEAN = 1, NUMERIC, STRING, OBJECT,
  SEQUENCE, MAP, BLOB
}
 
typedef ::fwAtoms::factory::Key Key
 
- Static Public Attributes inherited from fwAtoms::Base
static FWATOMS_API const std::string s_VERSION = "1"
 Defines fwAtoms version.
 
- Protected Member Functions inherited from fwAtoms::Base
 Base ()
 Constructor.
 

Detailed Description

Class represented a String.

Definition at line 23 of file fwAtoms/include/fwAtoms/String.hpp.

Constructor & Destructor Documentation

fwAtoms::String::String ( ::fwAtoms::Base::Key  key)
inline

Constructor.

Parameters
keyPrivate construction key

Definition at line 32 of file fwAtoms/include/fwAtoms/String.hpp.

Member Function Documentation

std::string fwAtoms::String::getString ( ) const
inlineoverridevirtual

Return the string representation of a value.

Returns
the value's representation, else "<Unknown>"

Reimplemented from fwAtoms::Base.

Definition at line 60 of file fwAtoms/include/fwAtoms/String.hpp.


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