JNET::JSubscriptionAny Struct Reference

Auxiliary class for any subscription. More...

#include <JControlHost.hh>

Inheritance diagram for JNET::JSubscriptionAny:

Public Member Functions
	JSubscriptionAny (const JTag &tag)
	Constructor. More...
JSubscription_t	getSubscription () const
	Get subscription type. More...
std::string	toString () const
	Convert subscription to string. 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...
	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
JSubscription_t	subscription
union {
char   tag [TAGSIZE]
JTag_t   id
};

Detailed Description

Auxiliary class for any subscription.

Definition at line 113 of file JControlHost.hh.

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

tag

tag

Definition at line 121 of file JControlHost.hh.

                                      :
      JSubscription(SUBSCRIBE_ANY, tag)
    {}

Member Function Documentation

JSubscription_t JNET::JSubscription::getSubscription ( ) const

inlineinherited

Get subscription type.

Returns

subscription

Definition at line 71 of file JControlHost.hh.

    {
      return subscription;
    }

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

inlineinherited

Convert subscription to string.

Returns

subscription

Definition at line 82 of file JControlHost.hh.

    {
      return std::string(1, (char) subscription) + " " + JTag::toString();
    }

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

inlineinherited

Get tag.

Returns

tag

Definition at line 82 of file JTag.hh.

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

JTag& JNET::JTag::getTag ( )

inlineinherited

Get tag.

Returns

tag

Definition at line 93 of file JTag.hh.

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

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

inlineinherited

Set tag.

Parameters

tag

tag

Returns

true if OK; else false

Definition at line 105 of file JTag.hh.

    {
      id = tag.getID();
    }

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

inlineinherited

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."));
      }
    }

JTag_t JNET::JTag::getID ( ) const

inlineinherited

Get identifier.

Returns

identifier

Definition at line 143 of file JTag.hh.

    { 
      return id;
    }

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

inlineinherited

Set identifier.

Returns

identifier

Definition at line 154 of file JTag.hh.

    { 
      this->id = id;

      return true;
    }

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

inlineinherited

Type conversion operators.

Returns

tag

Definition at line 184 of file JTag.hh.

    {
      return toString();
    }

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

inlineinherited

C-string.

Returns

tag

Definition at line 195 of file JTag.hh.

    {
      return tag;
    }

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

inlineinherited

Get character.

Parameters

i

index

Returns

character at index

Definition at line 207 of file JTag.hh.

    {
      return tag[i];
    }

Member Data Documentation

JSubscription_t JNET::JSubscription::subscription

protectedinherited

Definition at line 89 of file JControlHost.hh.

char JNET::JTag::tag[TAGSIZE]

inherited

Definition at line 247 of file JTag.hh.

JTag_t JNET::JTag::id

inherited

Definition at line 248 of file JTag.hh.

union { ... }

---

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

• JControlHost.hh