cml/libcw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cwObject.h,cwFlowTypes.h : Added comments.

Browse Source
This commit is contained in:
kevin 2024-06-01 08:02:31 -04:00
parent a5a296c636
commit a4a71100cf
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cwFlowTypes.h
View File

@ -468,7 +468,7 @@ namespace cw
void var_destroy( variable_t* var ); void var_destroy( variable_t* var );
// Channelizing creates a new var record with an explicit channel index to replace the // Channelizing creates a new var record with an explicit channel index to replace the
// automatically generated variable whose channel index is set to 'all'. // automatically generated variable whose channel index is set to 'kAnyChIdx'.
rc_t var_channelize( proc_t* proc, const char* var_label, unsigned sfx_id, unsigned chIdx, const object_t* value_cfg, unsigned vid, variable_t*& varRef ); rc_t var_channelize( proc_t* proc, const char* var_label, unsigned sfx_id, unsigned chIdx, const object_t* value_cfg, unsigned vid, variable_t*& varRef );
// Wrapper around call to var->proc->members->value() // Wrapper around call to var->proc->members->value()

9
cwObject.h
View File

@ -32,7 +32,9 @@ namespace cw
kHexFl = 0x10000000, kHexFl = 0x10000000,
kIdentFl = 0x20000000, kIdentFl = 0x20000000,
kOptFl = 0x40000000
kOptFl = 0x40000000,
kReqFl = 0x00000000,
}; };
@ -304,10 +306,13 @@ namespace cw
// readv("label0",flags0,v0,"label1",flags0,v1, ... ) // readv("label0",flags0,v0,"label1",flags0,v1, ... )
// Use kOptFl for optional fields. // Use kReqFl/kOptFl for required/optional fields.
// Use kListTId and kDictTId to validate the type of container fields. // Use kListTId and kDictTId to validate the type of container fields.
// In general it should not be necessary to validate numeric and string types because // In general it should not be necessary to validate numeric and string types because
// they are validated by virtue of being converted to the returned value. // they are validated by virtue of being converted to the returned value.
// Note that readv() assumes that the list of possible fields given as input is complete
// and any fields that it finds which are not in the list are not valid. This
// validity check is the main difference between readv() and getv()/getv_opt().
template< typename T0, typename T1, typename... ARGS > template< typename T0, typename T1, typename... ARGS >
rc_t readv( T0 label, unsigned flags, T1& valRef, ARGS&&... args ) const rc_t readv( T0 label, unsigned flags, T1& valRef, ARGS&&... args ) const
{ return _readv(nullptr, label,flags,valRef,args...); } { return _readv(nullptr, label,flags,valRef,args...); }