tools::sg::field_desc Class Reference

Inheritance diagram for tools::sg::field_desc:

Public Types
typedef ptrdiff_t	offset_t
typedef std::pair< std::string, int >	enum_t

Public Member Functions
	field_desc ()
	field_desc (const std::string &a_name, const std::string &a_class, offset_t a_offset, bool a_editable)
virtual	~field_desc ()
	field_desc (const field_desc &a_from)
field_desc &	operator= (const field_desc &a_from)
const std::string &	name () const
const std::string &	cls () const
offset_t	offset () const
void	add_enum (const std::string &a_key, int a_value)
const std::vector< enum_t > &	enums () const
void	add_opt (const std::string &a_value)
const std::vector< std::string > &	opts () const
bool	editable () const

Protected Attributes
std::string	m_name
std::string	m_class
offset_t	m_offset
bool	m_editable
std::vector< enum_t >	m_enums
std::vector< std::string >	m_opts

Detailed Description

Definition at line 21 of file field_desc.

Member Typedef Documentation

enum_t

typedef std::pair<std::string,int> tools::sg::field_desc::enum_t

Definition at line 76 of file field_desc.

offset_t

typedef ptrdiff_t tools::sg::field_desc::offset_t

Definition at line 27 of file field_desc.

Constructor & Destructor Documentation

field_desc() [1/3]

tools::sg::field_desc::field_desc ( )

inline

Definition at line 29 of file field_desc.

              :m_offset(0){ //touchy
//#ifdef TOOLS_MEM
//    mem::increment(s_class().c_str());
//#endif
  }

field_desc() [2/3]

tools::sg::field_desc::field_desc ( const std::string &  a_name, const std::string &  a_class, offset_t  a_offset, bool  a_editable  )

inline

Definition at line 34 of file field_desc.

  :m_name(a_name)
  ,m_class(a_class)
  ,m_offset(a_offset)
  ,m_editable(a_editable)
  {
//#ifdef TOOLS_MEM
//    mem::increment(s_class().c_str());
//#endif
  }

~field_desc()

virtual tools::sg::field_desc::~field_desc ( )

inlinevirtual

Definition at line 47 of file field_desc.

                       {
//#ifdef TOOLS_MEM
//    mem::decrement(s_class().c_str());
//#endif
  }

field_desc() [3/3]

tools::sg::field_desc::field_desc ( const field_desc &  a_from )

inline

Definition at line 53 of file field_desc.

  :m_name(a_from.m_name)
  ,m_class(a_from.m_class)
  ,m_offset(a_from.m_offset)
  ,m_editable(a_from.m_editable)
  ,m_enums(a_from.m_enums)
  ,m_opts(a_from.m_opts)
  {}

Member Function Documentation

add_enum()

void tools::sg::field_desc::add_enum ( const std::string &  a_key, int  a_value  )

inline

Definition at line 75 of file field_desc.

{m_enums.push_back(enum_t(a_key,a_value));}

add_opt()

void tools::sg::field_desc::add_opt ( const std::string &  a_value )

inline

Definition at line 79 of file field_desc.

{m_opts.push_back(a_value);}

cls()

const std::string& tools::sg::field_desc::cls ( ) const

inline

Definition at line 72 of file field_desc.

{return m_class;}

editable()

bool tools::sg::field_desc::editable ( ) const

inline

Definition at line 82 of file field_desc.

{return m_editable;}

enums()

const std::vector<enum_t>& tools::sg::field_desc::enums ( ) const

inline

Definition at line 77 of file field_desc.

{return m_enums;}

name()

const std::string& tools::sg::field_desc::name ( ) const

inline

Definition at line 71 of file field_desc.

{return m_name;}

offset()

offset_t tools::sg::field_desc::offset ( ) const

inline

Definition at line 73 of file field_desc.

{return m_offset;}

operator=()

field_desc& tools::sg::field_desc::operator= ( const field_desc &  a_from )

inline

Definition at line 61 of file field_desc.

                                                 {
    m_name = a_from.m_name;
    m_class = a_from.m_class;
    m_offset = a_from.m_offset;
    m_editable = a_from.m_editable;
    m_enums = a_from.m_enums;
    m_opts = a_from.m_opts;
    return *this;
  }

opts()

const std::vector<std::string>& tools::sg::field_desc::opts ( ) const

inline

Definition at line 80 of file field_desc.

{return m_opts;}

Member Data Documentation

m_class

std::string tools::sg::field_desc::m_class

protected

Definition at line 85 of file field_desc.

m_editable

bool tools::sg::field_desc::m_editable

protected

Definition at line 87 of file field_desc.

m_enums

std::vector<enum_t> tools::sg::field_desc::m_enums

protected

Definition at line 88 of file field_desc.

m_name

std::string tools::sg::field_desc::m_name

protected

Definition at line 84 of file field_desc.

m_offset

offset_t tools::sg::field_desc::m_offset

protected

Definition at line 86 of file field_desc.

m_opts

std::vector<std::string> tools::sg::field_desc::m_opts

protected

Definition at line 89 of file field_desc.

---

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

• /Users/barrand/private/dev/softinex/g4tools/g4tools/tools/sg/field_desc