cbsref/csyrefplugins/csy27010/inc/CsyMsgBufBPFrame.h
author hgs
Mon, 09 Aug 2010 17:35:42 +0100
changeset 58 980b3d0c4069
parent 44 8b72faa1200f
permissions -rw-r--r--
201027_10
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     1
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     2
// * Copyright 2004 Neusoft America Inc.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     3
// * All rights reserved.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     4
// * This component and the accompanying materials are made available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     5
// * under the terms of the Eclipse Public License v1.0
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     6
// * which accompanies this distribution, and is available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     7
// * at the URL "http://www.eclipse.org/legal/epl-v10.html".
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     8
// *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     9
// * Contributors:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    10
// * Keith Collins (Neusoft America Inc.)  original software development and additional code and modifications.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    11
// * Thomas Gahagen (Neusoft America Inc.)  additional code and modifications.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    12
// * Zhen Yuan (Neusoft America Inc.)  additional code and modifications.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    13
// *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    14
// * Description: This file defines the CCsyMsgBufBpFrame class.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    15
// *              This class is used to hold frame messages that the CSY sends to and 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    16
// *              receives from the BP multiplexer.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    17
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    18
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    19
// CsyMsgBufBpFrame.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    20
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    21
/** @file CsyMsgBufBpFrame.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    22
 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    23
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    24
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    25
#ifndef _CSYMSGBUFBPFRAME_H_
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    26
#define _CSYMSGBUFBPFRAME_H_
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    27
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    28
#include <e32base.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    29
#include "CsyGlobals.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    30
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    31
/** @class CCsyMsgBufBpFrame CsyMsgBufBpFrame.h "CsyMsgBufBpFrame.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    32
 *  @brief Class CCsyMsgBufBpFrame is used to hold frame messages 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    33
 *  that the CSY sends to and receives from the BP multiplexer.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    34
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    35
class CCsyMsgBufBpFrame : public CBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    36
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    37
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    38
	static CCsyMsgBufBpFrame* NewL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    39
	virtual ~CCsyMsgBufBpFrame();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    40
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    41
	TUint8 GetDlcNum() const;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    42
	TUint8 GetFrameType() const;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    43
	TUint8 GetType4FrameSequence() const;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    44
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    45
	TBuf8<KMaxAdvFrameSize> iMsg;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    46
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    47
	inline TUint8& CCsyMsgBufBpFrame::MsgDlc();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    48
	inline TBool& CCsyMsgBufBpFrame::CompleteWhenSent();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    49
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    50
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    51
	TSglQueLink iMsgLink;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    52
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    53
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    54
	CCsyMsgBufBpFrame();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    55
	void ConstructL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    56
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    57
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    58
	TUint8	iCsyMsgDlc;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    59
	TBool	iCompleteWhenSent;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    60
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    61
	};
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    62
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    63
inline TUint8& CCsyMsgBufBpFrame::MsgDlc()
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    64
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    65
	return iCsyMsgDlc;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    66
	}
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    67
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    68
inline TBool& CCsyMsgBufBpFrame::CompleteWhenSent()
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    69
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    70
	return iCompleteWhenSent;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    71
	}
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    72
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    73
#endif  //_CSYMSGBUFBPFRAME_H_