BdsApi  2.0.11
Public Member Functions | Public Attributes | List of all members
Bds::DataChannelInfo Class Reference

This class defines information on a data channel. More...

#include <BdsD.h>

Inheritance diagram for Bds::DataChannelInfo:

Public Member Functions

 DataChannelInfo (BUInt32 pid=0, BTimeStamp pstartTime=BTimeStamp(), BTimeStamp pendTime=BTimeStamp(), BString plocation=BString(), BString pformat=BString(), BString purl=BString(), BString pcomment=BString(), BUInt32 pimportUserId=0, BTimeStamp pimportTime=BTimeStamp(), BString pstate=BString())
 
BString getType ()
 
BError setMembers (BDictString &members)
 
BError setMember (BString name, BString value)
 
BError getMembers (BDictString &members)
 
BError getMember (BString name, BString &value)
 

Public Attributes

BUInt32 id
 ID. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time. More...
 
BString location
 The stoarge location. More...
 
BString format
 The data format. More...
 
BString url
 The URL for file access. More...
 
BString comment
 A comment on the file. More...
 
BUInt32 importUserId
 The user ID of the importing user. More...
 
BTimeStamp importTime
 The Time the data was imported. More...
 
BString state
 Status info on the import (inProgress, complete etc) More...
 

Detailed Description

This class defines information on a data channel.

Constructor & Destructor Documentation

◆ DataChannelInfo()

Bds::DataChannelInfo::DataChannelInfo ( BUInt32  pid = 0,
BTimeStamp  pstartTime = BTimeStamp(),
BTimeStamp  pendTime = BTimeStamp(),
BString  plocation = BString(),
BString  pformat = BString(),
BString  purl = BString(),
BString  pcomment = BString(),
BUInt32  pimportUserId = 0,
BTimeStamp  pimportTime = BTimeStamp(),
BString  pstate = BString() 
)

Member Function Documentation

◆ getMember()

BError Bds::DataChannelInfo::getMember ( BString  name,
BString &  value 
)

◆ getMembers()

BError Bds::DataChannelInfo::getMembers ( BDictString &  members)

◆ getType()

BString Bds::DataChannelInfo::getType ( )

◆ setMember()

BError Bds::DataChannelInfo::setMember ( BString  name,
BString  value 
)

◆ setMembers()

BError Bds::DataChannelInfo::setMembers ( BDictString &  members)

Member Data Documentation

◆ comment

BString Bds::DataChannelInfo::comment

A comment on the file.

◆ endTime

BTimeStamp Bds::DataChannelInfo::endTime

The End Time.

◆ format

BString Bds::DataChannelInfo::format

The data format.

◆ id

BUInt32 Bds::DataChannelInfo::id

ID.

◆ importTime

BTimeStamp Bds::DataChannelInfo::importTime

The Time the data was imported.

◆ importUserId

BUInt32 Bds::DataChannelInfo::importUserId

The user ID of the importing user.

◆ location

BString Bds::DataChannelInfo::location

The stoarge location.

◆ startTime

BTimeStamp Bds::DataChannelInfo::startTime

The Start Time.

◆ state

BString Bds::DataChannelInfo::state

Status info on the import (inProgress, complete etc)

◆ url

BString Bds::DataChannelInfo::url

The URL for file access.


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