anna::diameter::stack::Format Class Reference

#include <Format.hpp>

Public Member Functions
	Format (const Dictionary *d=NULL)
	~Format ()
const std::string &	getName (void) const
const std::string &	getParentName (void) const
const Format *	getParent (void) const
bool	isDerived (void) const
bool	isBasic (void) const
codec::Format::_v	getBasicType (void) const noexcept(false)
bool	isRFC3588 (void) const
bool	isAny () const
bool	isOctetString () const
bool	isInteger32 () const
bool	isInteger64 () const
bool	isUnsigned32 () const
bool	isUnsigned64 () const
bool	isFloat32 () const
bool	isFloat64 () const
bool	isGrouped () const
bool	isAddress () const
bool	isTime () const
bool	isUTF8String () const
bool	isDiameterIdentity () const
bool	isDiameterURI () const
bool	isEnumerated () const
bool	isIPFilterRule () const
bool	isQoSFilterRule () const
bool	isApplicationSpecific (void) const
bool	isReserved (void) const
std::string	asString (void) const
anna::xml::Node *	asXML (anna::xml::Node *parent) const
void	initialize (const Dictionary *d=NULL)
void	setName (const char *name) noexcept(false)
void	setRFC3588 (codec::Format::_v rfc3588Format)
void	setParentName (const std::string &parentName) noexcept(false)

Friends
bool	operator== (const Format &f1, const Format &f2)
bool	operator!= (const Format &f1, const Format &f2)

Detailed Description

Format data container

Constructor & Destructor Documentation

Format()

anna::diameter::stack::Format::Format ( const Dictionary *  d = NULL )

inline

{ _initialize(d); }

~Format()

anna::diameter::stack::Format::~Format ( )

inline

{};

Member Function Documentation

asString()

std::string anna::diameter::stack::Format::asString

(

void

)

const

Class string representation

Returns

String with class content

asXML()

anna::xml::Node* anna::diameter::stack::Format::asXML

(

anna::xml::Node *

parent

)

const

Class xml representation

Returns

XML document with relevant information for this instance.

getBasicType()

codec::Format::_v anna::diameter::stack::Format::getBasicType ( void  ) const

noexcept

Gets the diameter basic format type from which a derived type inherit, or basic type itself for non-derived

Returns

Diameter basic format type

getName()

const std::string& anna::diameter::stack::Format::getName ( void  ) const

inline

Gets the format type name

Returns

Format type name

{ return a_name; }

getParent()

const Format* anna::diameter::stack::Format::getParent

(

void

)

const

Gets the diameter parent type reference

Returns

Diameter parent type reference, NULL for diameter basic format types (and reserved like 'Any, Unknown')

getParentName()

const std::string& anna::diameter::stack::Format::getParentName ( void  ) const

inline

Gets the format parent type name

Returns

Format parent type name, empty string for diameter basic format types (and reserved like 'Any, Unknown')

{ return a_parentName; }

initialize()

void anna::diameter::stack::Format::initialize ( const Dictionary *  d = NULL )

inline

Initializes the class content

{ _initialize(d); }

isAddress()

bool anna::diameter::stack::Format::isAddress ( ) const

inline

Returns

The format is 'Address'

{ return (a_name == codec::Format::asText(codec::Format::Address)); }

isAny()

bool anna::diameter::stack::Format::isAny ( ) const

inline

Returns

The format is 'Any' (generic AVP)

{ return (a_name == codec::Format::asText(codec::Format::Any)); }

isApplicationSpecific()

bool anna::diameter::stack::Format::isApplicationSpecific ( void  ) const

inline

The diameter format is application-specific or a format type name not registered on dictionary

Returns

The format is application-specific

{ return (!isRFC3588() && !isReserved()); }

isBasic()

bool anna::diameter::stack::Format::isBasic ( void  ) const

inline

The diameter format is a basic type: (OctetString, Integer32, Integer64, Unsigned32, Unsigned64, Float32, Float64, Grouped)

Returns

The format is basic

{ return (!isDerived() && !isReserved()); }

isDerived()

bool anna::diameter::stack::Format::isDerived ( void  ) const

inline

The diameter format is a derived type

Returns

The format is derived

{ return (a_parentName != ""); }

isDiameterIdentity()

bool anna::diameter::stack::Format::isDiameterIdentity ( ) const

inline

Returns

The format is 'DiameterIdentity'

{ return (a_name == codec::Format::asText(codec::Format::DiameterIdentity)); }

isDiameterURI()

bool anna::diameter::stack::Format::isDiameterURI ( ) const

inline

Returns

The format is 'DiameterURI'

{ return (a_name == codec::Format::asText(codec::Format::DiameterURI)); }

isEnumerated()

bool anna::diameter::stack::Format::isEnumerated ( ) const

inline

Returns

The format is 'Enumerated'

{ return (a_name == codec::Format::asText(codec::Format::Enumerated)); }

isFloat32()

bool anna::diameter::stack::Format::isFloat32 ( ) const

inline

Returns

The format is 'Float32'

{ return (a_name == codec::Format::asText(codec::Format::Float32)); }

isFloat64()

bool anna::diameter::stack::Format::isFloat64 ( ) const

inline

Returns

The format is 'Float64'

{ return (a_name == codec::Format::asText(codec::Format::Float64)); }

isGrouped()

bool anna::diameter::stack::Format::isGrouped ( ) const

inline

Returns

The format is 'Grouped'

{ return (a_name == codec::Format::asText(codec::Format::Grouped)); }

isInteger32()

bool anna::diameter::stack::Format::isInteger32 ( ) const

inline

Returns

The format is 'Integer32'

{ return (a_name == codec::Format::asText(codec::Format::Integer32)); }

isInteger64()

bool anna::diameter::stack::Format::isInteger64 ( ) const

inline

Returns

The format is 'Integer64'

{ return (a_name == codec::Format::asText(codec::Format::Integer64)); }

isIPFilterRule()

bool anna::diameter::stack::Format::isIPFilterRule ( ) const

inline

Returns

The format is 'IPFilterRule'

{ return (a_name == codec::Format::asText(codec::Format::IPFilterRule)); }

isOctetString()

bool anna::diameter::stack::Format::isOctetString ( ) const

inline

Returns

The format is 'Unknown'

The format is 'OctetString'

{ return (a_name == codec::Format::asText(codec::Format::OctetString)); }

isQoSFilterRule()

bool anna::diameter::stack::Format::isQoSFilterRule ( ) const

inline

Returns

The format is 'QoSFilterRule'

{ return (a_name == codec::Format::asText(codec::Format::QoSFilterRule)); }

isReserved()

bool anna::diameter::stack::Format::isReserved ( void  ) const

inline

The diameter format is reserved ('Any' for generic AVP, 'Unknown' for not registered avps)

Returns

The format is reserved

{ return (codec::Format::isReserved(a_name)); }

isRFC3588()

bool anna::diameter::stack::Format::isRFC3588 ( void  ) const

inline

The diameter format belongs to RFC3588 diameter format family: (OctetString, Integer32, Integer64, Unsigned32, Unsigned64, Float32, Float64, Grouped, Address, Time, UTF8String, DiameterIdentity, DiameterURI, Enumerated, IPFilterRule, QoSFilterRule)

Returns

The format belongs to RFC3588

{ return (codec::Format::isRFC3588(a_name)); }

isTime()

bool anna::diameter::stack::Format::isTime ( ) const

inline

Returns

The format is 'Time'

{ return (a_name == codec::Format::asText(codec::Format::Time)); }

isUnsigned32()

bool anna::diameter::stack::Format::isUnsigned32 ( ) const

inline

Returns

The format is 'Unsigned32'

{ return (a_name == codec::Format::asText(codec::Format::Unsigned32)); }

isUnsigned64()

bool anna::diameter::stack::Format::isUnsigned64 ( ) const

inline

Returns

The format is 'Unsigned64'

{ return (a_name == codec::Format::asText(codec::Format::Unsigned64)); }

isUTF8String()

bool anna::diameter::stack::Format::isUTF8String ( ) const

inline

Returns

The format is 'UTF8String'

{ return (a_name == codec::Format::asText(codec::Format::UTF8String)); }

setName()

void anna::diameter::stack::Format::setName ( const char *  name )

inlinenoexcept

Sets Avp format type name

Parameters

type	Avp format type name

                                                  {
    if(name == NULL) throw anna::RuntimeException("Null Format-name not allowed", ANNA_FILE_LOCATION);

    a_name = name;

    if(a_name == "") throw anna::RuntimeException("Empty Format-name not allowed", ANNA_FILE_LOCATION);
  }

setParentName()

void anna::diameter::stack::Format::setParentName ( const std::string &  parentName )

noexcept

Sets Diameter-basic avp format parent

Parameters

parent

Diameter-basic avp format parent

setRFC3588()

void anna::diameter::stack::Format::setRFC3588 ( codec::Format::_v  rfc3588Format )

inline

Sets RFC3588 Avp format type name

Parameters

rfc3588Format

RFC3588 format type

                                               {
    setName(codec::Format::asText(rfc3588Format));
  }

Friends And Related Function Documentation

operator!=

bool operator!= ( const Format &  f1, const Format &  f2  )

friend

Returns

Difference between two class instances

{ return !(f1 == f2); }

operator==

bool operator== ( const Format &  f1, const Format &  f2  )

friend

Returns

Equality between two class instances

{ return ((f1.getName() == f2.getName())); }

---

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

• /tmp/anna/include/anna/diameter/stack/Format.hpp