maxon::DESCRIPTION::DATA::BASE Namespace Reference

Functions

 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.data.base")
 
 MAXON_ATTRIBUTE (Id, DATATYPE, "net.maxon.description.data.base.datatype", RESOURCE_DEFINE(ENUM_REGISTRY_MAXON_DB_DATADESCRIPTIONS, Id("registry#maxon.db.datadescriptions")))
 
 MAXON_ATTRIBUTE (Id, CLASSIFICATION, "net.maxon.description.data.base.classification", RESOURCE_DEFINE(ENUM_DATA, Id("data")))
 
 MAXON_ATTRIBUTE (Id, UNIT, "net.maxon.description.data.base.unit", RESOURCE_DEFINE(ENUM_TIME, Id("time")))
 
 MAXON_ATTRIBUTE (Data, DEFAULTVALUE, "net.maxon.description.data.base.defaultvalue")
 
 MAXON_ATTRIBUTE (Id, LIMITVALUE, "net.maxon.description.data.base.limitvalue", RESOURCE_DEFINE(ENUM_BOTH, Id("both")))
 
 MAXON_ATTRIBUTE (Data, MINVALUE, "net.maxon.description.data.base.minvalue")
 
 MAXON_ATTRIBUTE (Data, MAXVALUE, "net.maxon.description.data.base.maxvalue")
 
 MAXON_ATTRIBUTE (Id, INCLUDE, "net.maxon.description.data.base.include")
 
 MAXON_ATTRIBUTE (Array< Id >, INCLUDERENAME, "net.maxon.description.data.base.includerename")
 
 MAXON_ATTRIBUTE (Array< Id >, INCLUDEFILTER, "net.maxon.description.data.base.includefilter")
 
 MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Array< Tuple< Id, Data >>), ENUM, "net.maxon.description.data.base.enum")
 
 MAXON_ATTRIBUTE (Id, DATABASEID, "net.maxon.description.data.base.databaseid")
 
 MAXON_ATTRIBUTE (Bool, OVERWRITABLE, "net.maxon.description.data.base.overwritable")
 
 MAXON_ATTRIBUTE (Bool, ISVARIADIC, "net.maxon.description.data.base.isvariadic")
 
 MAXON_ATTRIBUTE (Int, VARIADICCOUNT, "net.maxon.description.data.base.variadiccount")
 
 MAXON_ATTRIBUTE (Array< Id >, VARIADICCOMMANDS, "net.maxon.description.data.base.variadiccommands")
 
 MAXON_ATTRIBUTE (VariadicIdsType, VARIADICIDS, "net.maxon.description.data.base.variadicids")
 
 MAXON_ATTRIBUTE (String, WARNINGS, "net.maxon.description.data.base.warnings")
 
 MAXON_ATTRIBUTE (CString, COMMENT, "net.maxon.description.data.base.comment")
 
 MAXON_ATTRIBUTE (Bool, GENERATEIGNOREHEADER, "net.maxon.description.data.base.generateignoreheader")
 
 MAXON_ATTRIBUTE (Bool, INHERITSTRING, "net.maxon.description.data.base.inheritstring")
 
 MAXON_ATTRIBUTE (Bool, OPTIONALSTRING, "net.maxon.description.data.base.optionalstring")
 
 MAXON_ATTRIBUTE (CString, NAMESPACE, "net.maxon.description.data.base.namespace")
 
 MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Tuple< Id, InternedId >), INCLUDEDFROM, "net.maxon.description.data.base.includedfrom")
 
 MAXON_ATTRIBUTE (Id, ORIGIN, "net.maxon.description.data.base.origin")
 
 MAXON_ATTRIBUTE (Group, GROUPDEV, "net.maxon.description.data.base.groupdev")
 
 MAXON_ATTRIBUTE (Group, GROUPINFO, "net.maxon.description.data.base.groupinfo")
 

Function Documentation

◆ MAXON_RESOURCE_DATABASE_SCOPE()

maxon::DESCRIPTION::DATA::BASE::MAXON_RESOURCE_DATABASE_SCOPE ( "net.maxon.description.data.base"  )

◆ MAXON_ATTRIBUTE() [1/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
DATATYPE  ,
"net.maxon.description.data.base.datatype"  ,
RESOURCE_DEFINE(ENUM_REGISTRY_MAXON_DB_DATADESCRIPTIONS, Id("registry#maxon.db.datadescriptions"))   
)

Use DataTypeLib::GetRuntimeDataType to query the correct const DataType*. Some datatypes need to be converted into runtime types. E.g. "int" and "float" will be adjusted to the 32 or 64 types which the compiler defined for the current platform. But also types based on Int or Float (such as Vector) have to be converted.

◆ MAXON_ATTRIBUTE() [2/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
CLASSIFICATION  ,
"net.maxon.description.data.base.classification"  ,
RESOURCE_DEFINE(ENUM_DATA, Id("data"))   
)

Classification of the attribute. This can be any of the given enum types.

◆ MAXON_ATTRIBUTE() [3/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
UNIT  ,
"net.maxon.description.data.base.unit"  ,
RESOURCE_DEFINE(ENUM_TIME, Id("time"))   
)

◆ MAXON_ATTRIBUTE() [4/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Data  ,
DEFAULTVALUE  ,
"net.maxon.description.data.base.defaultvalue"   
)

◆ MAXON_ATTRIBUTE() [5/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
LIMITVALUE  ,
"net.maxon.description.data.base.limitvalue"  ,
RESOURCE_DEFINE(ENUM_BOTH, Id("both"))   
)

◆ MAXON_ATTRIBUTE() [6/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Data  ,
MINVALUE  ,
"net.maxon.description.data.base.minvalue"   
)

◆ MAXON_ATTRIBUTE() [7/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Data  ,
MAXVALUE  ,
"net.maxon.description.data.base.maxvalue"   
)

◆ MAXON_ATTRIBUTE() [8/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
INCLUDE  ,
"net.maxon.description.data.base.include"   
)

◆ MAXON_ATTRIBUTE() [9/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Array< Id ,
INCLUDERENAME  ,
"net.maxon.description.data.base.includerename"   
)

◆ MAXON_ATTRIBUTE() [10/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Array< Id ,
INCLUDEFILTER  ,
"net.maxon.description.data.base.includefilter"   
)

◆ MAXON_ATTRIBUTE() [11/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( MAXON_MACROARG_TYPE(Array< Tuple< Id, Data >>)  ,
ENUM  ,
"net.maxon.description.data.base.enum"   
)

◆ MAXON_ATTRIBUTE() [12/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
DATABASEID  ,
"net.maxon.description.data.base.databaseid"   
)

Command info: database id which loaded this description.

◆ MAXON_ATTRIBUTE() [13/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Bool  ,
OVERWRITABLE  ,
"net.maxon.description.data.base.overwritable"   
)

True if the attribute should be overwritable for takes in the take system.

◆ MAXON_ATTRIBUTE() [14/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Bool  ,
ISVARIADIC  ,
"net.maxon.description.data.base.isvariadic"   
)

This attribute is set for a variadic port. A variadic port can be expanded a number of times.

◆ MAXON_ATTRIBUTE() [15/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Int  ,
VARIADICCOUNT  ,
"net.maxon.description.data.base.variadiccount"   
)

This attribute sets the default number of ports of a variadic port.

◆ MAXON_ATTRIBUTE() [16/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Array< Id ,
VARIADICCOMMANDS  ,
"net.maxon.description.data.base.variadiccommands"   
)

◆ MAXON_ATTRIBUTE() [17/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( VariadicIdsType  ,
VARIADICIDS  ,
"net.maxon.description.data.base.variadicids"   
)

contains an array of ids in case isvariadic is true. This value will be filled in programmatically.

◆ MAXON_ATTRIBUTE() [18/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( String  ,
WARNINGS  ,
"net.maxon.description.data.base.warnings"   
)

Show why the element has warnings.

◆ MAXON_ATTRIBUTE() [19/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( CString  ,
COMMENT  ,
"net.maxon.description.data.base.comment"   
)

Include export: comment to be added to the include export.

◆ MAXON_ATTRIBUTE() [20/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Bool  ,
GENERATEIGNOREHEADER  ,
"net.maxon.description.data.base.generateignoreheader"   
)

Command info: True to prevent this attribute from exporting to the header file.

◆ MAXON_ATTRIBUTE() [21/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Bool  ,
INHERITSTRING  ,
"net.maxon.description.data.base.inheritstring"   
)

True if the string should be inherited to descriptions which include this description.

◆ MAXON_ATTRIBUTE() [22/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Bool  ,
OPTIONALSTRING  ,
"net.maxon.description.data.base.optionalstring"   
)

True if the string is optional and doesn't need to be translated.

◆ MAXON_ATTRIBUTE() [23/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( CString  ,
NAMESPACE  ,
"net.maxon.description.data.base.namespace"   
)

Command info: namespace that generated that symbol.

◆ MAXON_ATTRIBUTE() [24/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( MAXON_MACROARG_TYPE(Tuple< Id, InternedId >)  ,
INCLUDEDFROM  ,
"net.maxon.description.data.base.includedfrom"   
)

Is only set if the attribute was included by another attribute. Id - database id of the included object Data - identifier of the include attribute

◆ MAXON_ATTRIBUTE() [25/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Id  ,
ORIGIN  ,
"net.maxon.description.data.base.origin"   
)

This value returns the original data type id which defined the attribute.

◆ MAXON_ATTRIBUTE() [26/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Group  ,
GROUPDEV  ,
"net.maxon.description.data.base.groupdev"   
)

◆ MAXON_ATTRIBUTE() [27/27]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE ( Group  ,
GROUPINFO  ,
"net.maxon.description.data.base.groupinfo"   
)