fw4spl
fwAtoms::Sequence Class Reference

Sequence represented a list of meta object. More...

#include <Sequence.hpp>

+ Inheritance diagram for fwAtoms::Sequence:
+ Collaboration diagram for fwAtoms::Sequence:

Public Types

typedef std::vector< Base::sptr > SequenceType
 
typedef SequenceType::value_type ValueType
 
typedef SequenceType::reference ReferenceType
 
typedef SequenceType::const_reference ConstReferenceType
 
typedef SequenceType::iterator IteratorType
 
typedef SequenceType::const_iterator ConstIteratorType
 
typedef SequenceType::reverse_iterator ReverseIteratorType
 
typedef SequenceType::const_reverse_iterator ConstReverseIteratorType
 
typedef SequenceType::size_type SizeType
 
typedef SequenceType::value_type value_type
 
typedef SequenceType::reference reference
 
typedef SequenceType::const_reference const_reference
 
typedef SequenceType::iterator iterator
 
typedef SequenceType::const_iterator const_iterator
 
typedef SequenceType::reverse_iterator reverse_iterator
 
typedef SequenceType::const_reverse_iterator const_reverse_iterator
 
typedef SequenceType::size_type size_type
 
- Public Types inherited from fwAtoms::Base
enum  AtomType {
  BOOLEAN = 1, NUMERIC, STRING, OBJECT,
  SEQUENCE, MAP, BLOB
}
 
typedef ::fwAtoms::factory::Key Key
 

Public Member Functions

virtual bool isA (const std::string &type) const override
 
 Sequence (::fwAtoms::Base::Key key)
 Constructor. More...
 
virtual ~Sequence ()
 Destructor.
 
void push_back (const Base::sptr &value)
 push an atom in the sequence.
 
IteratorType begin ()
 Begin of sequence iterator.
 
IteratorType end ()
 End of sequence iterator.
 
ConstIteratorType begin () const
 Begin of sequence const iterator.
 
ConstIteratorType end () const
 End of sequence const iterator.
 
size_type size () const
 Returns the sequence size.
 
void clear ()
 clear the sequence
 
bool empty () const
 Test if the sequence is empty.
 
const SequenceType & getValue () const
 Returns internal vector.
 
Base::sptr & operator[] (unsigned int index)
 access an element in position index
 
const Base::sptr & operator[] (unsigned int index) const
 
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...
 
virtual FWATOMS_API std::string getString () const
 Return the string representation of a value. More...
 
- Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- 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

SequenceType 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

- 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

Sequence represented a list of meta object.

Definition at line 22 of file Sequence.hpp.

Member Typedef Documentation

typedef SequenceType::const_iterator fwAtoms::Sequence::const_iterator

boost_foreach/stl compatibility

Definition at line 44 of file Sequence.hpp.

typedef SequenceType::const_reference fwAtoms::Sequence::const_reference

boost_foreach/stl compatibility

Definition at line 42 of file Sequence.hpp.

typedef SequenceType::const_reverse_iterator fwAtoms::Sequence::const_reverse_iterator

boost_foreach/stl compatibility

Definition at line 46 of file Sequence.hpp.

typedef SequenceType::iterator fwAtoms::Sequence::iterator

boost_foreach/stl compatibility

Definition at line 43 of file Sequence.hpp.

typedef SequenceType::reference fwAtoms::Sequence::reference

boost_foreach/stl compatibility

Definition at line 41 of file Sequence.hpp.

typedef SequenceType::reverse_iterator fwAtoms::Sequence::reverse_iterator

boost_foreach/stl compatibility

Definition at line 45 of file Sequence.hpp.

typedef SequenceType::size_type fwAtoms::Sequence::size_type

boost_foreach/stl compatibility

Definition at line 47 of file Sequence.hpp.

typedef SequenceType::value_type fwAtoms::Sequence::value_type

boost_foreach/stl compatibility

Definition at line 40 of file Sequence.hpp.

Constructor & Destructor Documentation

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

Constructor.

Parameters
keyPrivate construction key

Definition at line 54 of file Sequence.hpp.


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