#include <LATcontribution.h>
Inheritance diagram for LATcontribution:
Public Types | |
| ID = LATidentity_(LATprimaryId::Any, LATsecondaryId::Any) | |
| enum | { ID = LATidentity_(LATprimaryId::Any, LATsecondaryId::Any) } |
Public Member Functions | |
| LATcontribution () | |
| Constructor setting up identity and length defaults. | |
| LATcontribution (LATtypeId identity, unsigned length) | |
| Constructor setting up identity and length defaults. | |
| LATtypeId | identity () const |
| Return the identity of this block. | |
| LATcontribution * | next () const |
| Return the next contribution in the datagram. | |
| unsigned | length () const |
| Return the length of this block. | |
| unsigned | rawDataSize () const |
| Return the size of the rawData in the contribution. | |
| char * | rawData () const |
| Return a pointer to the rawData in the contribution. | |
| void * | operator new (size_t) |
| Allocate a default LATcontribution off the memory heap. | |
| void * | operator new (size_t, LATtypeId identity, unsigned length) |
| Allocate a LATcontribution with space for a payload off the memory heap. | |
| void * | operator new (size_t, const LATcontribution &) |
| Copy a LATcontribution to a new one. | |
| void * | operator new (size_t, void *, unsigned short supplemental, bool swap=!DFC_BIG_ENDIAN) |
| This operator new allows one to place a contribution at a given location. | |
| void | operator delete (void *, void *, unsigned short, bool) |
| Delete operator used to delete a contribution. | |
| void | operator delete (void *) |
| Delete operator used to delete a contribution. | |
| unsigned char * | string (bool swap=!DFC_BIG_ENDIAN) |
Return a pointer to a LATcontribution as a uchar buffer. | |
Static Public Member Functions | |
| static LATcontribution * | create (LATtypeId identity, unsigned size, unsigned char *buffer, bool swap=!DFC_BIG_ENDIAN) |
Create a LATcontribution from a uchar buffer. | |
Copyright: Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
| LATcontribution::LATcontribution | ( | LATtypeId | identity, | |
| unsigned | length | |||
| ) | [inline] |
Constructor setting up identity and length defaults.
| identity | The structure identifier of this LATcontribution | |
| length | Amount of space in bytes to reserve for this LATcontribution Must be less than USHORT_MAX (64K Bytes) |
| LATcontribution * LATcontribution::create | ( | LATtypeId | identity, | |
| unsigned | size, | |||
| unsigned char * | buffer, | |||
| bool | swap = !DFC_BIG_ENDIAN | |||
| ) | [inline, static] |
Create a LATcontribution from a uchar buffer.
This method primarily exists for the Python interface.
The buffer can optionally be byte swapped by longwords in place. By default, if the endianness of the machine this code is running on is not big endian, then the buffer is byte swapped.
| identity | The structure identifier of this LATcontribution | |
| size | Amount of space in bytes to reserve for this LATcontribution Must be less than USHORT_MAX (64K Bytes) | |
| buffer | A pointer to a buffer containing LATcontribution data | |
| swap | Optionally byte swap the buffer in place |
| void LATcontribution::operator delete | ( | void * | location | ) | [inline] |
Delete operator used to delete a contribution.
This method is used to avoid SIP constructor MemberCode.
| void LATcontribution::operator delete | ( | void * | , | |
| void * | , | |||
| unsigned | short, | |||
| bool | ||||
| ) | [inline] |
Delete operator used to delete a contribution.
This method is used to avoid SIP constructor MemberCode.
| void * LATcontribution::operator new | ( | size_t | size, | |
| void * | location, | |||
| unsigned short | supplemental, | |||
| bool | swap = !DFC_BIG_ENDIAN | |||
| ) | [inline] |
This operator new allows one to place a contribution at a given location.
This method is used to effectively label a piece of memory containing contribution data a LATcontribution. It is similar to casting a pointer to a LAT contribution pointer.
In the process or placing the contribution, the raw data occupying the space can optionally be byte swapped. By default, if the endianness of the machine this code is running on is not big endian, then the buffer is byte swapped.
| size | An ignored parameter | |
| location | A pointer to the location where to place the contribution | |
| supplemental | Additional space to include in the contribution | |
| swap | Optionally byte swap the buffer in place |
| void * LATcontribution::operator new | ( | size_t | size, | |
| const LATcontribution & | contribution | |||
| ) | [inline] |
Copy a LATcontribution to a new one.
This method is used to avoid SIP constructor MemberCode.
| size | An ignored parameter | |
| contribution | A reference to the contribution to be copied |
| void * LATcontribution::operator new | ( | size_t | size, | |
| LATtypeId | identity, | |||
| unsigned | length | |||
| ) | [inline] |
Allocate a LATcontribution with space for a payload off the memory heap.
This method is used to avoid SIP constructor MemberCode.
| size | An ignored parameter | |
| identity | The structure identifier of this LATcontribution | |
| length | Amount of space in bytes to reserve for this LATcontribution Must be less than USHORT_MAX (64K Bytes) |
| void * LATcontribution::operator new | ( | size_t | size | ) | [inline] |
Allocate a default LATcontribution off the memory heap.
This method is used to avoid SIP constructor MemberCode.
| size | An ignored parameter |
| char * LATcontribution::rawData | ( | ) | const [inline] |
Return a pointer to the rawData in the contribution.
| unsigned LATcontribution::rawDataSize | ( | ) | const [inline] |
Return the size of the rawData in the contribution.
| unsigned char * LATcontribution::string | ( | bool | swap = !DFC_BIG_ENDIAN |
) | [inline] |
Return a pointer to a LATcontribution as a uchar buffer.
This method primarily exists for the Python interface.
The buffer can optionally be byte swapped by longwords in place. By default, if the endianness of the machine this code is running on is not big endian, then the buffer is byte swapped. Be sure to supply FALSE for the swap argument if the buffer has already been swapped by a previous call.
| swap | Optionally byte swap the buffer in place |
Reimplemented in ASCcontribution, and EBFevent.
1.4.7