.TH "Vector::BLF::DistributedObjectMember" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::DistributedObjectMember \- Distributed object member (communication setup)  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <DistributedObjectMember\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMemberType\fP : uint32_t { \fBMemberTypeInvalid\fP = 0, \fBMemberTypeData\fP = 1, \fBMemberTypeMethod\fP = 2, \fBMemberTypeField\fP = 3, \fBMemberTypeEvent\fP = 4, \fBMemberTypeRefMember\fP = 5, \fBMemberTypeRefObject\fP = 6, \fBMemberTypeBindingError\fP = 7 }"
.br
.RI "type of the distributed object member "
.ti -1c
.RI "enum \fBDetailType\fP : uint32_t { \fBDetailTypeInvalid\fP = 0, \fBDetailTypeValue\fP = 1, \fBDetailTypeFunctionCall\fP = 2, \fBDetailTypeFunctionReturn\fP = 3, \fBDetailTypeFunctionDefaults\fP = 4, \fBDetailTypeSubscriptionState\fP = 5, \fBDetailTypeAnnouncementState\fP = 6, \fBDetailTypeReferencePath\fP = 7, \fBDetailTypeBindingError\fP = 8 }"
.br
.RI "detail type of the distributed object "
.in -1c

Public Types inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\fP, \fBconst\fP \fBuint16_t\fP \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBuint16_t\fP \fBheaderVersion\fP, \fBconst\fP ObjectType \fBobjectType\fP)"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBmemberType\fP {\fBMemberType::MemberTypeInvalid\fP}"
.br
.RI "type of the distributed object member "
.ti -1c
.RI "\fBuint32_t\fP \fBdetailType\fP {\fBDetailType::DetailTypeInvalid\fP}"
.br
.RI "detail type of the distributed object "
.ti -1c
.RI "\fBuint32_t\fP \fBpathLength\fP"
.br
.RI "length of variable name in bytes "
.ti -1c
.RI "\fBuint32_t\fP \fBdataLength\fP"
.br
.RI "length of variable data in bytes "
.ti -1c
.RI "std::string \fBpath\fP"
.br
.RI "path of the distributed object member "
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBdata\fP"
.br
.RI "variable data "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "\fBuint16_t\fP \fBclientIndex\fP {}"
.br
.RI "client index of send node "
.ti -1c
.RI "\fBuint16_t\fP \fBobjectVersion\fP {0}"
.br
.RI "object specific version "
.ti -1c
.RI "\fBuint64_t\fP \fBobjectTimeStamp\fP {}"
.br
.RI "object timestamp "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "\fBuint32_t\fP \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SH "Detailed Description"
.PP 
Distributed object member (communication setup) 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::DistributedObjectMember::DetailType\fP : \fBuint32_t\fP"

.PP
detail type of the distributed object 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIDetailTypeInvalid \fP\fP
BL_DO_DETAIL_TYPE_INVALID 
.TP
\fB\fIDetailTypeValue \fP\fP
BL_DO_DETAIL_TYPE_VALUE 
.TP
\fB\fIDetailTypeFunctionCall \fP\fP
BL_DO_DETAIL_TYPE_FUNCTION_CALL 
.TP
\fB\fIDetailTypeFunctionReturn \fP\fP
BL_DO_DETAIL_TYPE_FUNCTION_RETURN 
.TP
\fB\fIDetailTypeFunctionDefaults \fP\fP
BL_DO_DETAIL_TYPE_FUNCTION_DEFAULTS 
.TP
\fB\fIDetailTypeSubscriptionState \fP\fP
BL_DO_DETAIL_TYPE_SUBSCRIPTION_STATE 
.TP
\fB\fIDetailTypeAnnouncementState \fP\fP
BL_DO_DETAIL_TYPE_ANNOUNCEMENT_STATE 
.TP
\fB\fIDetailTypeReferencePath \fP\fP
BL_DO_DETAIL_TYPE_REFERENCE_PATH 
.TP
\fB\fIDetailTypeBindingError \fP\fP
BL_DO_DETAIL_TYPE_BINDING_ERROR 
.SS "\fBenum\fP \fBVector::BLF::DistributedObjectMember::MemberType\fP : \fBuint32_t\fP"

.PP
type of the distributed object member 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIMemberTypeInvalid \fP\fP
BL_DO_MEMBER_TYPE_INVALID 
.TP
\fB\fIMemberTypeData \fP\fP
BL_DO_MEMBER_TYPE_DATA 
.TP
\fB\fIMemberTypeMethod \fP\fP
BL_DO_MEMBER_TYPE_METHOD 
.TP
\fB\fIMemberTypeField \fP\fP
BL_DO_MEMBER_TYPE_FIELD 
.TP
\fB\fIMemberTypeEvent \fP\fP
BL_DO_MEMBER_TYPE_EVENT 
.TP
\fB\fIMemberTypeRefMember \fP\fP
BL_DO_MEMBER_TYPE_DOREF_MEMBER 
.TP
\fB\fIMemberTypeRefObject \fP\fP
BL_DO_MEMBER_TYPE_DOREF_OBJECT 
.TP
\fB\fIMemberTypeBindingError \fP\fP
BL_DO_MEMBER_TYPE_BINDING_ERROR 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::DistributedObjectMember::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"
Calculates the objectSize
.PP
\fBReturns\fP
.RS 4
object size 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "\fBvoid\fP Vector::BLF::DistributedObjectMember::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"
Read the data of this object
.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "\fBvoid\fP Vector::BLF::DistributedObjectMember::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"
Write the data of this object
.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.