• Overview
  • Examples
  • HowTos
  • Glossary
    • Public Types | Public Member Functions | Static Public Attributes | Related Functions | List of all members
    senf::UInt24Parser Struct Reference
    The PacketParser facility » Integer parsers

    Parse 24bit unsigned byte aligned integer. More...

    #include <senf/Packets/IntParser.hh>

    Inheritance diagram for senf::UInt24Parser:
    Inheritance graph
    [legend]

    Public Types

    typedef boost::uint32_t value_type
     
    - Public Types inherited from senf::PacketParserBase
    typedef detail::packet::iterator data_iterator
     Raw data iterator type. More...
     
    typedef detail::packet::size_type size_type
     Unsigned integral type. More...
     
    typedef detail::packet::difference_type difference_type
     Signed integral type. More...
     
    typedef detail::packet::byte byte
     Unsigned 8bit value, the raw value type. More...
     
    typedef PacketData * state_type
     Type of the 'state' parameter. More...
     
    typedef PacketParserBase parser_base_type
     Base type of the next parser. More...
     

    Public Member Functions

     UInt24Parser (data_iterator i, state_type s)
     
    value_type value () const
     
    void value (value_type v)
     
    UInt24Parser const & operator= (value_type other)
     
    - Public Member Functions inherited from senf::PacketParserBase
    data_iterator i () const
     Return beginning of data to parse. More...
     
    data_iterator i (size_type offset) const
     Return iterator offset bytes from the start. More...
     
    state_type state () const
     Return state of this parser. More...
     
    PacketData & data () const
     Access the packets raw data container. More...
     
    void init () const
     Default implementation. More...
     

    Static Public Attributes

    static size_type const fixed_bytes = 3
     
    static value_type const min_value = 0u
     
    static value_type const max_value = 16777215u
     

    Related Functions

    (Note that these are not member functions.)

    std::ostream & operator<< (std::ostream &os, UInt24Parser const &i)
     Write parsed value to stream. More...
     

    Additional Inherited Members

    - Protected Member Functions inherited from senf::PacketParserBase
    ParserProtector protect () const
     
     PacketParserBase (data_iterator i, state_type s)
     Standard constructor. More...
     
     PacketParserBase (data_iterator i, state_type s, size_type size)
     Size checking constructor. More...
     
    bool check (size_type size) const
     Check size of data container. More...
     
    void validate (size_type size) const
     Validate size of data container. More...
     
    template<class Parser >
    Parser parse (data_iterator i) const
     Create sub-parser. More...
     
    template<class Parser , class Arg >
    Parser parse (Arg const &arg, data_iterator i) const
     Create sub-parser. More...
     
    template<class Parser >
    Parser parse (size_type n) const
     Create sub-parser. More...
     
    template<class Parser , class Arg >
    Parser parse (Arg const &arg, size_type n) const
     Create sub-parser. More...
     
    void defaultInit () const
     Default implementation. More...
     
    Packet packet () const
     Get packet this parser is parsing from. More...
     
    void resize (size_type oldSize, size_type newSize)
     Resize data container. More...
     

    Detailed Description

    Parse 24bit unsigned byte aligned integer.

    See also
    Integer parsers

    Definition at line 256 of file IntParser.hh.

    Member Typedef Documentation

    ◆ value_type

    typedef boost::uint32_t senf::UInt24Parser::value_type

    Definition at line 264 of file IntParser.hh.

    Constructor & Destructor Documentation

    ◆ UInt24Parser()

    senf::UInt24Parser::UInt24Parser ( data_iterator  i,
    state_type  s 
    )
    		inline

    Definition at line 260 of file IntParser.hh.

    Member Function Documentation

    ◆ operator=()

    UInt24Parser const& senf::UInt24Parser::operator= ( value_type  other)
    		inline

    Definition at line 271 of file IntParser.hh.

    ◆ value() [1/2]

    value_type senf::UInt24Parser::value ( ) const
    		inline

    Definition at line 269 of file IntParser.hh.

    ◆ value() [2/2]

    void senf::UInt24Parser::value ( value_type  v)
    		inline

    Definition at line 270 of file IntParser.hh.

    Friends And Related Function Documentation

    ◆ operator<<()

    std::ostream & operator<< ( std::ostream &  os,
    UInt24Parser const &  i 
    )
    		related

    Write parsed value to stream.

    Definition at line 276 of file IntParser.hh.

    Member Data Documentation

    ◆ fixed_bytes

    size_type const senf::UInt24Parser::fixed_bytes = 3
    		static

    Definition at line 265 of file IntParser.hh.

    ◆ max_value

    value_type const senf::UInt24Parser::max_value = 16777215u
    		static

    Definition at line 267 of file IntParser.hh.

    ◆ min_value

    value_type const senf::UInt24Parser::min_value = 0u
    		static

    Definition at line 266 of file IntParser.hh.

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