rnr::cmd::DataSect Class Reference

Command line interface data section class. More...

#include <CommandLine.h>

Public Types
typedef void(*	DeallocFunc) (void *)

Public Member Functions
	DataSect ()
	Default constructor.
	DataSect (const std::string &ns, void *pData, DeallocFunc fn=NULL)
	Initialization constructor. More...
	~DataSect ()
	Destructor.
void	set (const std::string &ns, void *pData, DeallocFunc fn=NULL)
const std::string &	ns () const
	Return namespace. More...
void *	data ()
	Return section data. More...
const void *	data () const
	Return section data. More...
DeallocFunc	deallocator ()
	Return deallocator. More...
const DeallocFunc	deallocator () const
	Return deallocator. More...

Public Attributes
std::string	m_strNs
	data section namespace
void *	m_pData
	pointer to section data
DeallocFunc	m_fnDealloc
	data deallocator function

Friends
std::ostream &	operator<< (std::ostream &os, const DataSect &obj)
	Insert object into output stream. More...

Detailed Description

Command line interface data section class.

The cli can support multiple data sections, each delineated by a unique namespace.

If a data deallocator function is specifed, the section data will be automatically deleted when the command line data section is is deleted.

Definition at line 315 of file CommandLine.h.

Member Typedef Documentation

typedef void(* rnr::cmd::DataSect::DeallocFunc) (void *)

data section data deallocator function type.

Definition at line 319 of file CommandLine.h.

Constructor & Destructor Documentation

rnr::cmd::DataSect::DataSect	(	const std::string &	ns,
		void *	pData,
		DeallocFunc	fn = NULL
	)

Initialization constructor.

Parameters

ns	///< data section namespace
pData	///< pointer to section data
fn	///< data deallocator function

Member Function Documentation

void* rnr::cmd::DataSect::data ( )

inline

Return section data.

Returns

Void pointer.

Definition at line 361 of file CommandLine.h.

      {
        return m_pData;
      }

const void* rnr::cmd::DataSect::data ( ) const

inline

Return section data.

Returns

Constant void pointer.

Definition at line 371 of file CommandLine.h.

      {
        return m_pData;
      }

DeallocFunc rnr::cmd::DataSect::deallocator ( )

inline

Return deallocator.

Returns

Pointer to function.

Definition at line 381 of file CommandLine.h.

      {
        return m_fnDealloc;
      }

const DeallocFunc rnr::cmd::DataSect::deallocator ( ) const

inline

Return deallocator.

Returns

Constant pointer to function.

Definition at line 391 of file CommandLine.h.

References rnr::cmd::CmdExec::operator<<.

      {
        return m_fnDealloc;
      }

const std::string& rnr::cmd::DataSect::ns ( ) const

inline

Return namespace.

Returns

String.

Definition at line 351 of file CommandLine.h.

      {
        return m_strNs;
      }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const DataSect &  obj  )

friend

Insert object into output stream.

Parameters

os	Output stream.
obj	Object to insert.

Returns

Reference to output stream.

---

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

• include/rnr/appkit/CommandLine.h
• sw/librnr_appkit/CommandLine.cxx