JNET::JTag Class Reference

ControlHost tag. More...

#include <JTag.hh>

Inheritance diagram for JNET::JTag:

Public Member Functions
	JTag ()
	Default constructor. More...
	JTag (const JTag &tag)
	Copy constructor. More...
	JTag (const std::string &tag)
	Constructor. More...
	JTag (const JTag_t id)
	Constructor. More...
const JTag &	getTag () const
	Get tag. More...
JTag &	getTag ()
	Get tag. More...
void	setTag (const JTag &tag)
	Set tag. More...
void	setTag (const std::string &tag)
	Set tag. More...
JTag_t	getID () const
	Get identifier. More...
bool	setID (const JTag_t id)
	Set identifier. More...
std::string	toString () const
	Convert tag to string. More...
	operator std::string () const
	Type conversion operators. More...
const char *	c_str () const
	C-string. More...
const char	operator[] (int i) const
	Get character. More...

Protected Attributes
union {
char   tag [TAGSIZE]
JTag_t   id
};

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

Detailed Description

ControlHost tag.

Definition at line 35 of file JTag.hh.

Constructor & Destructor Documentation

JTag() [1/4]

JNET::JTag::JTag ( )

inline

Default constructor.

Definition at line 40 of file JTag.hh.

    {}

JTag() [2/4]

JNET::JTag::JTag ( const JTag &  tag )

inline

Copy constructor.

Parameters

tag

tag

Definition at line 49 of file JTag.hh.

    {
      id = tag.getID();
    }

JTag() [3/4]

JNET::JTag::JTag ( const std::string &  tag )

inline

Constructor.

Parameters

tag

tag

Definition at line 60 of file JTag.hh.

    {
      setTag(tag);
    }

JTag() [4/4]

JNET::JTag::JTag ( const JTag_t  id )

inline

Constructor.

Parameters

id	identifier

Definition at line 71 of file JTag.hh.

    {
      setID(id);
    }

Member Function Documentation

getTag() [1/2]

const JTag& JNET::JTag::getTag ( ) const

inline

Get tag.

Returns

tag

Definition at line 82 of file JTag.hh.

    {
      return static_cast<const JTag&>(*this);
    }

getTag() [2/2]

JTag& JNET::JTag::getTag ( )

inline

Get tag.

Returns

tag

Definition at line 93 of file JTag.hh.

    {
      return static_cast<JTag&>(*this);
    }

setTag() [1/2]

void JNET::JTag::setTag ( const JTag &  tag )

inline

Set tag.

Parameters

tag

tag

Returns

true if OK; else false

Definition at line 105 of file JTag.hh.

    {
      id = tag.getID();
    }

setTag() [2/2]

void JNET::JTag::setTag ( const std::string &  tag )

inline

Set tag.

Parameters

tag

tag

Returns

true if OK; else false

Definition at line 117 of file JTag.hh.

    {
      if (!tag.empty() && tag.size() <= TAGSIZE) {
        
        size_t i = 0;
 
        for ( ; i < tag.size(); ++i) {
          this->tag[i] = tag[i];
        }
 
        for ( ; i < TAGSIZE;    ++i) {
          this->tag[i] = '\0';
        }
 
      } else {
 
        return throw(JControlHostException("JTag::setTag() invalid tag length."));
      }
    }

getID()

JTag_t JNET::JTag::getID ( ) const

inline

Get identifier.

Returns

identifier

Definition at line 143 of file JTag.hh.

    { 
      return id;
    }

setID()

bool JNET::JTag::setID ( const JTag_t  id )

inline

Set identifier.

Returns

identifier

Definition at line 154 of file JTag.hh.

    { 
      this->id = id;
 
      return true;
    }

toString()

std::string JNET::JTag::toString ( ) const

inline

Convert tag to string.

Returns

tag

Definition at line 167 of file JTag.hh.

    {
      int pos = TAGSIZE;
 
      while (pos != 0 && tag[pos-1] == '\0') {
        --pos;
      }
 
      return std::string(tag, pos);
    }

operator std::string()

JNET::JTag::operator std::string ( ) const

inline

Type conversion operators.

Returns

tag

Definition at line 184 of file JTag.hh.

    {
      return toString();
    }

c_str()

const char* JNET::JTag::c_str ( ) const

inline

C-string.

Returns

tag

Definition at line 195 of file JTag.hh.

    {
      return tag;
    }

operator[]()

const char JNET::JTag::operator[] ( int  i ) const

inline

Get character.

Parameters

i

index

Returns

character at index

Definition at line 207 of file JTag.hh.

    {
      return tag[i];
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JTag &  object  )

friend

Read JTag from input stream.

Parameters

in	input stream
object	JTag

Returns

input stream

Definition at line 220 of file JTag.hh.

    {
      std::string buffer;
 
      if (in >> buffer) {
        object.setTag(buffer);
      }
      
      return in;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JTag &  object  )

friend

Write JTag to output stream.

Parameters

out	output stream
object	JTag

Returns

output stream

Definition at line 239 of file JTag.hh.

    {
      return out << object.toString();
    }

Member Data Documentation

tag

char JNET::JTag::tag[TAGSIZE]

Definition at line 247 of file JTag.hh.

id

JTag_t JNET::JTag::id

Definition at line 248 of file JTag.hh.

@47

union { ... }

---

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

• JTag.hh