JEEP::JContainer< JContainer_t > Struct Template Reference

Auxiliary wrapper for I/O of container with optional comment (see JComment). More...

#include <JContainer.hh>

Inheritance diagram for JEEP::JContainer< JContainer_t >:

Public Types
typedef JContainer_t	container_type

Public Member Functions
void	load (const char *file_name)
	Load from input file. More...
void	store (const char *file_name) const
	Store to output file. More...

Public Attributes
JComment	comment

Friends
std::istream &	operator>> (std::istream &in, JContainer &container)
	Read container from input. More...
std::ostream &	operator<< (std::ostream &out, const JContainer &container)
	Write container to output. More...

Detailed Description

template<class JContainer_t>
struct JEEP::JContainer< JContainer_t >

Auxiliary wrapper for I/O of container with optional comment (see JComment).

When used in conjunction with the command line parser JPARSER::JParser,
the value at the corresponding option can contain data or be the name of a file.
The I/O of the actual container is handled via the auxiliary methods that are part of JStreamToolkit.hh.

Definition at line 39 of file JContainer.hh.

Member Typedef Documentation

template<class JContainer_t>

typedef JContainer_t JEEP::JContainer< JContainer_t >::container_type

Definition at line 43 of file JContainer.hh.

Member Function Documentation

template<class T>

void JLANG::JObjectStreamIO< T >::load ( const char *  file_name )

inlineinherited

Load from input file.

Parameters

file_name

file name

Definition at line 30 of file JObjectStreamIO.hh.

    {
      JLANG::load<std::ifstream>(file_name, static_cast<T&>(*this));
    }

template<class T>

void JLANG::JObjectStreamIO< T >::store ( const char *  file_name ) const

inlineinherited

Store to output file.

Parameters

file_name

file name

Definition at line 41 of file JObjectStreamIO.hh.

    {
      JLANG::store<std::ofstream>(file_name, static_cast<const T&>(*this));
    }

Friends And Related Function Documentation

template<class JContainer_t>

std::istream& operator>> ( std::istream &  in, JContainer< JContainer_t > &  container  )

friend

Read container from input.

Parameters

in	input stream
container	container

Returns

input stream

Definition at line 53 of file JContainer.hh.

    {
      using namespace JPP;

      JStringStream is(in);

      if (getFileStatus(is.str().c_str())) {
        is.load();
      }

      is >> container.comment;

      readObject(is, static_cast<container_type&>(container));

      return in;
    }

template<class JContainer_t>

std::ostream& operator<< ( std::ostream &  out, const JContainer< JContainer_t > &  container  )

friend

Write container to output.

Parameters

out	output stream
container	container

Returns

output stream

Definition at line 78 of file JContainer.hh.

    {
      using namespace std;
      using namespace JPP;

      out << container.comment;

      writeObject(out, "", static_cast<const container_type&>(container), '\n');
      
      return out;
    }

Member Data Documentation

template<class JContainer_t>

JComment JEEP::JContainer< JContainer_t >::comment

Definition at line 90 of file JContainer.hh.

---

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

• JContainer.hh